samswag / osf-website Goto Github PK

1. Getting started
2. Installation Guide
3. Format and lint
4. Contributors
5. License

1. Fork this repository (Learn how to do this)

2. Clone the forked repository like so:

git clone https://github.com/<your username>/osf-website.git && cd osf-website

3. Read the Contributors 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 develop

Gatsby will then start a hot-reloading development environment accessible by default at localhost:8000.

• Create a production build using the comand below:

npm run build

Gatsby 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 serve

Gatsby 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 commit

We 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.

• 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 fix

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 💻

Become a financial contributor and help us sustain our community. [Contribute]

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

This repository is published under the MIT license.