Skip to content

Latest commit

 

History

History
85 lines (54 loc) · 2.14 KB

README.md

File metadata and controls

85 lines (54 loc) · 2.14 KB

Codeflow

Official website of codeflow on React and Firebase

Design of Home Page

Scrollable Home Page with 1920x1080 px dimension in one Frame. Click Home to see the design.

Design of Events Page

Scrollable Home Page with 1920x1080 px dimension in one Frame. Click Events to see the design.

Prerequisites for Environment Setup

$ npm -v

terminal should return your npm version.

Environment Setup for CodeFlow

1. Clone App

  • Make a new folder and open the terminal there.
  • Write the following command and press enter.
  $ git clone [email protected]:CodeFlow201/codeflow.git

2. Install node packages

  • Move inside the cloned folder with name codeflow.
  • Write the following command and press enter to download all required node modules.
$ npm install .

3. Run Locally

  • While you are still inside the cloned folder, write the following command to run the website locally.
  $ npm run start
NOTE: The port by default will be http://localhost:3000/

Want to Contribute?

To start contributing, follow the below guidelines:

1. Fork this repository.

2. Follow the Environment setup above.

3. Checkout into a new branch

 $ git checkout -b <branch_name>

4. Make your changes

5. Add and commit your changes

 $ git add . && git commit -m "<your_message>"

6. Push Code to Github under your branch

 $ git push origin <branch_name>

Contributors