Table of contents
Getting Started
-
Fork this repository (Learn how to do this)
-
Clone the forked repository like so:
git clone https://github.com/<your username>/osf-website.git && cd osf-website- Read the Contributors Guide.
Installation Guide
- Install the Gatsby CLI using the command below:
npm install -g gatsby-cli- Make sure you're in the right site folder. You can do this with the command below:
cd osf-website- Create and checkout to a new branch for your feature using the command below:
git checkout -b speakers-component- Install required packages using the command below:
npm install- Start the development server using the comand below:
npm run developGatsby will then start a hot-reloading development environment accessible by default at localhost:8000.
- Create a production build using the comand below:
npm run buildGatsby will perform an optimized production build, generating static HTML and per-route JavaScript code bundles.
- Serve the production build locally using the comand below:
npm run serveGatsby starts a local HTML server for testing the built site. Remember to build the site using gatsby build before using this command.
- Make Git commits using the comand below:
npm run commitWe use the commitizen command line utility, you'll be prompted to fill out any required commit fields at commit time. You would not need to run git commit again.
Format and lint
- See what ESLint and Prettier can fix using the comand below:
npm run analyze- Run Prettier and ESLint with the --fix option using the comand below:
npm run fixContributors
 Bolaji Ayodeji |
 Peace Ojemeh |
 Steve Anthony |
 OFOR |
 Alabo David Briggs |
 Bolaji Olajide |
 Ike Josh |
 Favour Kelvin |
 Ashinze Ekene |
 Ndibe Raymond Olisaemeka |
 Chidimma Nwanya |
 Anselem Odimegwu |
Financial Contributors
Become a financial contributor and help us sustain our community. [Contribute]
Individuals
Organizations
Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]
Licence
This repository is published under the MIT license.