README.md

OSSN

Welcome to Open Source Student Network page repository!

Contents

1. Setup
2. Develop
3. Build

Setting up the project

1. Install nodeJS. Use your OS package manager to install nodeJS or follow the instructions on nodeJS page.
2. Clone the repository. Run git clone https://github.com/ossn/ossn-frontend.git.
3. Install nvm. Follow the instructions on nvm repo.
4. Run nvm use.
5. Install node dependencies. On repo directory run npm install.

Develop

1. At the repository directory run nvm use.
2. Open development server. Run npm run develop.
   • The page will be available at localhost:8000 by default.
3. Login to the development page is available through the url: https://dev.ossn.club/api/v1.0/oidc/login. After login you will be redirected to localhost:8000.

Build

1. At the repository directory run nvm use.
2. Building the page. Run npm run build.
3. Start the server. Run npm run serve to initialize a gatsby server at your machine.

• The page will be available localhost:9000 by default.

Find out more about the tools we used at https://www.gatsbyjs.org/