Skip to content

Commit

Permalink
Add README section on running the site
Browse files Browse the repository at this point in the history
  • Loading branch information
mukul-rathi committed Apr 2, 2020
1 parent e6ce933 commit f56b238
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,30 @@ Happy coding! I've written a [blog post explaining this repo in more depth](http

Feel free to submit issues if you feel this can be improved!

## Installation
## Getting started

This is a Gatsby starter repo:
This is a Gatsby starter repo so install it using the Gatsby CLI by running

`gatsby new your-gatsby-blog https://github.com/mukul-rathi/gatsby-starter-reason-blog/`

Alternatively you can fork this repo and then clone it:

`git clone https://github.com/your-github-username/gatsby-starter-reason-blog/`

Then to set up the repo:

```bash
cd your-gatsby-blog
yarn install # install dependencies
yarn develop # or gatsby develop
```

Your site is now running at `https://localhost:8000/`! Start making changes to the source code and see the site update live!

To learn more about Gatsby head to the [Gatsby website](https://www.gatsbyjs.org/).

The structure of this repository is based off the [Gatsby starter blog](https://github.com/gatsbyjs/gatsby-starter-blog) - check that README out if you want more information about the top level structure of a typical Gatsby project.

## Tips

JS interop with Reason can be a little messy at times. [This article](https://reasonml.github.io/docs/en/converting-from-js) helps you convert from JS. If `localhost:8000` displays uncaught TypeError messages when running `gatsby develop` but your Reason code compiles, check your JS-Reason bindings (imports/exports). :)
Expand Down

0 comments on commit f56b238

Please sign in to comment.