fakela / oscafrica.org

🔥 New OSCA Website (WIP)

oscafrica.org

Getting Started

1. Fork this repository

2. Clone the forked repository like so:

git clone https://github.com/<your username>/oscafrica.org.git && cd oscafrica.org

3. Read the Contributors Guide

Installation Guide

1. Install the Gatsby CLI

npm install -g gatsby-cli

2. Change directories into site folder

cd oscafrica.org

3. Create and checkout to a new branch for your feature

git checkout -b gallery-component

4. Start development server

npm run dev

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

5. Create a production build

npm run build

Gatsby will perform an optimized production build, generating static HTML and per-route JavaScript code bundles.

6. Serve the production build locally

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.

7. Run Storybook

npm run storybook

Storybook will start a hot-reloading development environment accessible on a random open port

8. Make Git commits

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.

Format and lint

1. See what ESLint and Prettier can fix

npm run analyze

2. Run Prettier and ESLint with the --fix option

npm run fix