Some friends of mine are going to bike from Denver, Colorado to Buenos Aires, Argentina, so I helped build their travel blog using React (thanks to CRA and RGM).
clicky clicky clicky
To get your machine and this code friendly and acquainted:
Clone this repository using your preferred method and cd into it. If you're not sure, I
recommend the SSH route:
git clone git@github.com:tmikeschu/the-spoken-tour.git
cd the-spoken-tour
Then, install dependencies:
yarn install
# copy configuration
cp .env.example .env
You'll need to create your own Google Maps API key, and you'll have to contact me for the Rails API key.
First things first: get a dopamine hit from a verdant test suite! Run the tests with:
yarn test
Then read the tests to get oriented with the application.
What fun is setting up and running tests if you can't do some of your own stuff? Start the local server with:
yarn start
Node: 8.1.2
Languages: JavaScript/ES6
DBs: External API
Major Libraries:
DevOps: Heroku
CI: Travis CI
When contributing to code, be the tofu. In other words, take on the style of the existing code. Here are some main approaches I follow:
- If a component doesn't hold its own state, write it as a pure function
- ES6
- No semi-colons
- Double quotes
- Unit tests for functions that process data
- For functions with side effects, unit test with mock
jest.fn()functions to verify the call of other functions. - Dependency injection for any API service functions
Interested in helping out?
-
Reach out to me and say hello! I'd love to hear about what you're interested in.
-
Once we've confirmed what you can work on, fork this repo and work on your masterpiece.
-
Once your work is done, squash your work to a single commit, and open a PR from your feature branch to this repo's master branch.