This project is meant to be a relatively simple demonstration of the types of challenges a developer might face early on at Lonely Planet. It will also test some simple implementations of React and, as a bonus, GraphQL.
Instructions for setting up the repo and your development environment are below. Please reach out for help if you have trouble getting setup, as environments can be a pain and this part is not the point of the exercise.
When you're ready to show off your work, push your commits to your fork either on the master
branch or some other. Then, if you return to lonelyplanet's upstream version of this repo, you should be prompted by Github to open a pull request. Then, we'll be able to review.
-
Fork the repo on Github
From the repo in Github (https://github.com/lonelyplanet/front-end-candidate-react) use Github's fork functionality to create a copy on your own personal profile so you can begin development. At the time of writing there is a button in the top right corner of the page to do this.
-
Clone fork onto your machine.
From a parent directory of your choice, run the following command, replacing the github username with your own:
git clone [email protected]:vacas5/front-end-candidate-react.git
This requires that your computer already has git installed.
-
Install dependencies.
-
Navigate into your new site’s directory.
cd front-end-candidate-react/
-
Verify node version
To install dependencies, first ensure you have Node installed on your machine, and are using version 10.13.0 or higher. To check which version you have installed (if you have it installed), you can run
node -v
. It should print the version or tell you that it can't run the command in the event node isn't installed at all.We recommend using nvm to manage your node versions if you don't have the right one installed.
-
Install dependencies using yarn
yarn install
This requires that you also have yarn installed on your local machine.
-
Install gatsby-cli
This tool will help you run the development server. Run the following command to install:
npm install -g gatsby-cli
-
-
Start developing.
Now for the fun part
gatsby develop
-
Open the source code and start editing!
Your site is now running at
http://localhost:8000
!Note: You'll also see a second link:
http://localhost:8000/___graphql
. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.Open the
front-end-candidate-react
directory in your code editor of choice and editsrc/pages/index.js
. Save your changes and the browser will update in real time!
A quick look at the top-level files and directories you'll see in a Gatsby project.
.
├── node_modules
├── src
├── .gitignore
├── .prettierrc
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── package-lock.json
├── package.json
└── README.md
-
/node_modules
: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed. -
/src
: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template.src
is a convention for “source code”. -
.gitignore
: This file tells git which files it should not track / not maintain a version history for. -
.prettierrc
: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent. -
gatsby-browser.js
: This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser. -
gatsby-config.js
: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail). -
gatsby-node.js
: This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process. -
gatsby-ssr.js
: This file is where Gatsby expects to find any usage of the Gatsby server-side rendering APIs (if any). These allow customization of default Gatsby settings affecting server-side rendering. -
LICENSE
: Gatsby is licensed under the MIT license. -
package-lock.json
(Seepackage.json
below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly). -
package.json
: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project. -
README.md
: A text file containing useful reference information about your project.
Looking for more guidance? Full documentation for Gatsby lives on the website. Here are some places to start:
-
For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.
-
To dive straight into code samples, head to our documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.