backend.opensource.org.rw

This is the Backend of opensource.org.rw, find the frontend here

DEPLOYMENTS

• develop branch(staging) is deployed at api-staging.opensource.org.rw
• master branch(production) is deployed at api.opensource.org.rw

The main responsibility of the backend is to use Github API and Slack API to provide services listed below:

Action:

• Automatic invitation (users can invite themselves to be the member of the organization)
• add users to public teams automatically
• getting list of repositories and their details

insights:

• number of current members
• number of repository
• popular repositories
• insights about projects

slack:

• generate invitation for a user to join the workspace
• join slack channels
• slack workspace's token, only for members

for members (API of cloudflare)

• get a sub-domain of opensource.org.rw

Have another good idea or feature**

• join our slack workspace
• join slack channel called #opensource_org_rw
• check the pivotal tracker
• raise a ticket on pivotal tracker(if you gonna work on it) or issue github(if you need someone else to work on it)

SETTING UP

It's mandatory to use NODE 12.X and this project is fully TypeScript

• clone this repo and cd to the working directory
• follow instructions in .env.sample file and setup your .env file.
• install dependencies by yarn install
• start the app in development mode yarn run start:dev
• start the app in production mode yarn start
• running tests yarn test
• to compile source down to ES5 yarn run build
• HAPPY CODING! 😎

CONTRIBUTIONS

ARE VERY WELCOMED 🙏, once your PR is merged don't forget to add yourself in file called AUTHORS

License

Licensed by BSD 3-Clause License