https://github.com/dataforgoodfr/website2022
New Data For Good website
https://github.com/dataforgoodfr/website2022
Last synced: 6 days ago
JSON representation
New Data For Good website
- Host: GitHub
- URL: https://github.com/dataforgoodfr/website2022
- Owner: dataforgoodfr
- License: mit
- Created: 2021-12-27T16:20:52.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-30T15:41:17.000Z (about 4 years ago)
- Last Synced: 2024-04-24T10:06:58.458Z (almost 2 years ago)
- Language: JavaScript
- Size: 12 MB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
### Installation
```
$ yarn
```
### Local Development
```
$ yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
Using SSH:
```
$ USE_SSH=true yarn deploy
```
Not using SSH:
```
$ GIT_USER= yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
### Docker
If you wish to use Docker, a default Dockerfile is available in `.devcontainer/` to build a docker using a node image from Microsoft.
If using VSCode to develop, the additionnal file `.devcontainer/devcontainer.json` will allow to:
* Suggest opening/starting the container when opening the repository in VSCode
* Forward port 3000 to the local host (default port for Docusaurus development server)
* Run `yarn install` to install required dependencies for the project
* Install VSCode ESLint extension