cbf-community-website

This is the repository for the Coding Black Females community website

• For the React site readme, click here

---

To test your changes to the website before raising a PR (Pull Request)

Prerequisites

• Node.js (including NPM) - learn more about Node.js here

Node.js installation

How do i know if i have nodeJS installed

In your command line terminal (e.g. iTerm or Terminal), TYPE:

node -v

This should tell you which Node.js version you have installed. ✅

If not, please install it to continue. There are various ways to install Node.js

---

How to install Node.js

The simplest way is to download Node.js pre-built installer here

Alternatively, you can install from the command line terminal using Homebrew

If you use Homebrew for example, TYPE:

brew install node

In any case, please choose whichever method suits you.

---

How to get these files on your computer so you can work on it locally

If you have not already done so ... Git clone this repo e.g. TYPE:

git clone https://github.com/CodingBlackFemales/cbf-community-website.git

more info on this from here: Git-Basics-Getting-a-Git-Repository

---

Steps to run to CBF community website locally

Now for the fun bit 😅 - launching 🚀 the webserver locally 💻

In the command line do the following, TYPE:

• cd cbf-community-website - to go into the CBF Community Website project folder

• cd functions - to go into the functions/ folder

• npm install - to install all the required node modules from package.json

• npm run local or node index.js - this will launch the website locally

If all went well 🤞🏿 you can now view your local version of cbf community website here:

http://localhost:3000 🎊

If you have any problems or suggestions let us know so we can update this README

That's it! Happy coding black females

👩🏿‍💻

Credits

Bootstrap theme cloned from Start Bootstrap's Stylish Portfolio