Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oddcamp/gatsby-starter-oddcamp
GatsbyJS starter that implements Styled Components + SASS.
https://github.com/oddcamp/gatsby-starter-oddcamp
gatsby gatsby-starter gatsbyjs
Last synced: about 1 month ago
JSON representation
GatsbyJS starter that implements Styled Components + SASS.
- Host: GitHub
- URL: https://github.com/oddcamp/gatsby-starter-oddcamp
- Owner: oddcamp
- License: mit
- Created: 2019-06-12T11:31:09.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-04T03:18:16.000Z (almost 2 years ago)
- Last Synced: 2023-03-12T07:42:09.040Z (almost 2 years ago)
- Topics: gatsby, gatsby-starter, gatsbyjs
- Language: JavaScript
- Homepage: https://gatsby-starter-oddcamp.netlify.app/
- Size: 17.5 MB
- Stars: 5
- Watchers: 10
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gatsby-starter-oddcamp
Our default starter for GatsbyJS projects at [Odd Camp](https://www.oddcamp.com).
## Online demo
[https://gatsby-starter-oddcamp.netlify.app](https://gatsby-starter-oddcamp.netlify.app)
[](https://app.netlify.com/sites/gatsby-starter-oddcamp/deploys)
## Environment variables
Create `.env` file when developing locally:
```
URL=http://localhost:8000
```
`URL` is set automatically in Netlify.
## Development Container
The project also include a config for the new [Visual Studio Code Remote - Containers system](https://code.visualstudio.com/docs/remote/containers) where your editor aswell as the code is inside of a container.
To get this working you need to follow the steps below:
1. Install the [Remote Development extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) and follow the setup guide for the extension.
2. On any project that has it setup a popup will show up in the bottom right asking you to re-open it in the container, just click `Re-open in container` and it will start it up.
3. We don't start the development servers automatically for this variant.
So to start a process you should click on the `Terminal` tab in the bottom of the editor and enter the commands you want below.
**Development server:** `yarn develop-n`
**Build:** `yarn build` and `yarn serve-n`
Any changes to the dependencies should be run in the editor. To create a new terminal in the container just click the `+` button.
## Development Environment
We provide two ways of developing locally but **we recommend using Docker as the default**.
### Docker
1. Provide your [Github Access Token](https://github.com/settings/tokens) if you use Private Github packages. Otherwise use blank.
Put `GITHUB_ACCESS_TOKEN=` in `.env`.
2. Run `$ docker-compose build`
3. Run `$ docker-compose up`
(this starts a `yarn install` and `yarn develop-n`)
4. Visit your development environment on [localhost:8000](http://localhost:8000).
**Testing**
1. Create a build and serve it by running
`$ docker-compose run --rm app ./scripts/build.sh`
2. Visit the build on [localhost:9000](http://localhost:9000)
### Locally (outside of Docker)
1. Install dependencies `$ yarn install`
2. Start development server: `$ yarn develop`: [localhost:8000](http://localhost:8000)
Or `$ yarn develop-n` for sharing the server on your network (`192.168.X.X:8000`)
**Testing**
1. Make a build `$ yarn build`
2. Serve the build `$ yarn serve`: [localhost:9000](http://localhost:9000)
Or `$ yarn serve-n` for sharing the server on your network (`192.168.X.X:9000`)
## Private packages
**Note: This is only needed if it's using packages from Github Packages**
If a project is using a private package (such as a `components` package), you can do a change where you put your token in the `.env` file instead of having it globally on the shell. For that to work you need to put `GITHUB_ACCESS_TOKEN=` in the `.env` and uncomment the `- .env` file in `docker-compose.yml` and rebuild by running `docker-compose build --force --no-cache`
**To get your Token and set the project up:**
1. Get your [Github Access Token here](https://github.com/settings/tokens).
2. Put `GITHUB_ACCESS_TOKEN=` in the `.env` file.
3. Add `"preinstall": "node ./scripts/append-gha.js",` to the `scripts` hash in `package.json`.
This makes sure that the keys are set before running yarn.
4. Add our `k-deployer` token in the Netlify (or whatever system you use) in the `GITHUB_ACCESS_TOKEN` environment variable.