The Daedalus News Website
The master branch is always live here.
yarn
: Installs previous dependencies and updates lockfile (shouldn't be used by everyone).npm run deps
: Installs previously listed dependencies, relying solely on lockfile (should be used).yarn add <PACKAGE>
: Installs a new package, make sure you need it and someone else hasn't installed it already.
It's worth noting npm run <command>
just runs the command listed in the package.json. You can also use yarn <command>
. There shouldn't be a difference, but when installing dependencies, use yarn
.
npm run develop
: Run Gatsby website locally (http://localhost:8000/) with hot reload.npm run build
: Create static production build for website intobuild/
.npm run clean
: Get rid of previous cache of builds (usually unnecessary).
Although code of conducts usually aren't needed, people should think before working with others and likewise people should be able to work without stress. Follow our code of conduct to help maintain a healthy community.
There are many ways in which you can participate in the project, for example:
- See an open pull request? You can try reviewing it!
- Find a pesky bug or perhaps a neat place to refactor? Report it or fix it with a PR!
- Notice some weird or missing documentation? Fix or add it with a PR! (Feeling a bit lazy, just report it 😆)
- Want to give a recommendation for a feature? Go ahead and open an issue with this template.
Feel free to open a pull request, check our contributing guide for more details.
This project uses an MIT license, which can be viewed here.