Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 4.12 KB

CONTRIBUTING.md

File metadata and controls

69 lines (45 loc) · 4.12 KB
Raw

Contribution guide

This repository is about building an open source portfolio management system. You can contribute to any part of the project from a small UI change to a humangous change in the system architecture. You can find current issues on the issues tab or create a new issue there. Once issue is assigned to you, you may fork the repo (if not done already) and start working on the perticular task. Once the task is done, create a pull request and wait till it gets merged. Don't ping or assign reviewers.

Before you start

As the project is very big and works on a lot of frameworks, you should learn the perticular thing(s) relavant to your task before you start working on the project.

ReactJS

React. js is an open-source JavaScript library that is used for building user interfaces specifically for single-page applications. It's used for handling the view layer for web and mobile apps. React also allows us to create reusable UI components. Our website is built on this framework and hence you might like to go through the documentation before you start working on the frontend of this project.

NodeJs

Node. js is a platform built on Chrome's JavaScript runtime for easily building fast and scalable network applications. Node. js uses an event-driven, non-blocking I/O model that makes it lightweight and efficient, perfect for data-intensive real-time applications that run across distributed devices. Our backend is written on Nodejs, so it's convenient to go through nodejs documentation once if you're not familiar with it. Nodejs can be downloaded from here. It's suggested to use a node version manager to install and work with different versions of NodeJS in a single device.

Azure services

Our API is based on microservice architecture and hosted on Azure functions, so it's suggested to learn it if you don't have prior experience with it. Check out this quickstart guide in such case. Also check out Azure blob storage and cosmosDB as they were used along with Azure function in this project. Also get to learn about Azure static apps, as our whole project is hosted on it. you should understand the dev commands before you kickstart.

MongoDB

We have used a mongoDB database for storing data from our application. You should get familiar with it in case yu want to contribute to the server side. Check out mongoose also as it's being used for the implementation of MongoDB database in our application.

Install the dependencies

Once you have nodejs and reactjs libraries installed, you can run the following code to install additional libraries used to work with Azure tools.

> npm run dev-install

Add environment variables to the API

Create a file in the api folder named local.settings.json by adding local or hosted URLs for the databases. Needed for frontend developers also as the project uses both in development mode in the runtime.

{
  "IsEncrypted": false,
  "Values": {
    "AzureWebJobsStorage": "",
    "FUNCTIONS_WORKER_RUNTIME": "node",
    "MONGO_LINK": <add a link to a mongodb database>,
    "AZURE_BLOB_CONNECTION_STRING": <add a connection link to blob storage>,
    "AZURE_BLOB_URL": <add the link to the blob storage>,
    "REACT_APP_GOOGLE_AUTH_CLIENT_ID": <create a google client ID and add in there>,
    "HOST": "http://localhost:7071"
  }
}

Run the application

Run the website and API

Run this command and don't close this terminal

> npm start

Contribution

Once you're done with the previous steps, you can start working on the issue assigned to you.

  • Create a pull request from the forked repo to the organization repo
  • You should tick the checklist in the pull request template
  • You should make sure there are no errors in the GitHub CI tests