https://github.com/contentful/covid-19-site-template
#project-covid19
https://github.com/contentful/covid-19-site-template
Last synced: 10 months ago
JSON representation
#project-covid19
- Host: GitHub
- URL: https://github.com/contentful/covid-19-site-template
- Owner: contentful
- License: mit
- Archived: true
- Created: 2020-03-14T10:54:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-07-22T07:06:18.000Z (almost 5 years ago)
- Last Synced: 2024-09-21T16:02:05.720Z (almost 2 years ago)
- Language: JavaScript
- Homepage: https://demo.stop-the-spread.dev/
- Size: 7.28 MB
- Stars: 40
- Watchers: 28
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gatsby-covid-19-template
Gatsby [Contentful](https://www.contentful.com) starter for creating a website for Covid-19 information
If you have information to share during the Covid-19 pandemic, we’re here to help. This solution enables organizations to quickly and easily publish a website. We hope to help communities stay better informed and connected in the midst of closures and quarantine.
## Contribution
This project is part of [contentful-userland](https://github.com/contentful-userland). We’re always open to contributions — **you can be part of userland and contribute to the project after your first merged pull request**. Learn more about how contentful userland is organized by visiting [our repository](https://github.com/contentful-userland/about).
## Requirements
You must have a Contentful account to use this project. If you don’t have an account yet, you can register for one at [www.contentful.com/sign-up](https://www.contentful.com/sign-up/).
The following instructions are helpful is you have Yarn installed. If not, please install [Yarn](https://yarnpkg.com/en/docs/install).
## Create with Stackbit
Use the "Create with Stackbit" button to easily deploy this project with just a few clicks. The GitHub project, the Contentful provisioning and the Netlify deploy will all be handled for you.
[](https://app.stackbit.com/create?theme=https://github.com/contentful/covid-19-site-template&ssg=gatsby&cms=contentful&cmsExclusive)
### Get the source code and install dependencies.
```
$ git clone https://github.com/contentful/covid-19-site-template.git
$ yarn install
```
Or use the [Gatsby CLI](https://www.npmjs.com/package/gatsby-cli).
```
$ gatsby new covid-19-site-template https://github.com/contentful/covid-19-site-template
```
### Set up of the needed content model and create a configuration file
```
npm i -g contentful-cli
```
```
contentful login
```
For the next step, please refer to the Contentful account you have, as described in the `Requirements` section. You need the space ID of your contentful space. This can be found in any URL after logging into Contentful. Look for `https://app.contentful.com/spaces//...`, which should be a short alphanumeric code. Use this value whenever you see ``.
```sh
rm static/_redirects
```
```
yarn setup
```
This command will ask you for a space ID, and access tokens for the Contentful Management and Delivery API. It then imports the content model into the space you define and writes a config file (`.env`).
## Crucial Commands
This project comes with a few handy commands for linting and code fixing. The most important ones are those to develop and ship code. You can find the most important commands below.
### `yarn develop`
Run in the project locally.
### `yarn build`
Run a production build into `./public`. The result is ready to be put on the static hosting you prefer.
## Roadmap
- [ ] Add Search
## Other resources
- Tutorial video series ["Building a blazing fast website with GatsbyJS and Contentful"](https://www.youtube.com/watch?v=Ek4o40w1tH4&list=PL8KiuH6vpACV-F7jXribe4YveGBhBeG9A) by @Khaledgarbaya