vartikasaxena / talawa-api

API Backend for the Talawa Mobile App

Talawa API

Talawa is a modular open source project to manage group activities of both non-profit organizations and businesses.

Core features to be developed include:

1. Membership management
2. Groups management
3. Event registrations
4. Recurring meetings
5. Facilities registrations

This has been a Calico Challenge project in 2019. It will be written in python with close integrations with the Plone open source content management system.

Documentation

• The talawa documentation can be found here.
• Visit the talawa GitHub site to see the code.

About Talawa

talawa is based on the original quito code created by the Palisadoes Foundation as part of its annual Calico Challenge program. Calico provides paid summer internships for Jamaican university students to work on selected open source projects. They are mentored by software professionals and receive stipends based on the completion of predefined milestones. Calico was started in 2015.

Installation

Prerequesites

Talawa API development prerequisites

• Node v12.14.1 (or later)

Clone and change into the project

git clone https://github.com/PalisadoesFoundation/talawa-api.git
cd talawa-api

Install packages

npm install

To run the project in development mode, run the following command

npm run start

For testing, run the following command

npm run test

Start developing!

Environment Variables

To run this api five environment variables need to be set in a .env file in the root of the api:

1. MONGO_USER
2. MONGO_PASSWORD
3. MONGO_DB
4. MONGO_URL
5. MONGO_LOCAL_INSTANCE
6. ACCESS_TOKEN_SECRET
7. REFRESH_TOKEN_SECRET
8. LOCAL_DB_REQUIRES_AUTH

If you are running mongodb locally only the MONGO_DB and MONGO_LOCAL_INSTANCE env vars are necessary. MONGO_USER and MONGO_PASSWORD are only necessary if you are connecting to a hosted instance of mongodb using atlas. If your local mongodbb required auth set the LOCAL_DB_REQUIRES_AUTH var to true and ensure the MONGO_PASSWORD and MONGO_USER vars are set

Image Upload

To enable image upload functionalities create an images folder in the root of the project

Configuration with Frontend

View how to configure backend with the flutter app