README.md

Getting Started

• Fork this repository

• Clone the forked repository with the command below:

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

• Read the Contributors Guide

Installation Guide

• Install the required packages with the command below:

yarn

• Create and checkout to a new branch for your feature with the command below:

git checkout -b <branch name>

• Start development server with the command below:

yarn run dev

Nextjs will start a hot-reloading development server accessible by default at localhost:3000. You can start a custom dev environent on a new port like so:

yarn dev -- -p 6000

• Start a Storybook development server with the command below:

yarn run storybook

• Create a production build with the command below:

yarn run build

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

Git commits

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.

Contributors

Alabo David Briggs 💻

Princess Oluebube Egbuna 💻

Bolaji Ayodeji 💻 📖

Ioana Chiorean 🤔

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]