deo002 / talawa-admin

Admin portal for the Talawa Mobile App. Click on the link below to see our documentation

Talawa Admin

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

Core features include:

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

talawa is based on the original quito code created by the [Palisadoes Foundation][pfd] 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. Visit The Palisadoes Foundation's website for more details on its origin and activities.

Talawa Components

talawa has these major software components:

1. talawa: A mobile application with social media features
2. talawa-api: An API providing access to user data and features
3. talawa-admin: A web based administrative portal
4. talawa-docs: The online documentation website

Documentation

• The talawa documentation can be found here.
• Want to contribute? Look at CONTRIBUTING.md to get started.
• Visit the Talawa-Docs GitHub to see the code.

Project Setup

1. Clone this repo to your local machine

   git clone https://github.com/PalisadoesFoundation/talawa-admin
   cd talawa-admin
   yarn install
   

2. Talawa-ADMIN uses a configuration file named .env in the root directory. It is not a part of the repo and you will need to create it. There is a sample configuration file named .env.example in the root diretory. Create a new .env file by copying the contents of the .env.example file.

   cp .env .env.example
   

3. Run Talawa-api locally in your system, and copy the URL to the REACT_APP_BACKEND_ENDPOINT section of the .env file.

   Talawa-API: https://github.com/PalisadoesFoundation/talawa-api
   

4. When finished, your .env file should have the following field filled in.

   • REACT_APP_BACKEND_ENDPOINT

   Please review the contents of the .env.example file for additional details.

Compiles and hot-reloads for development

yarn serve

Compiles and minifies for production

yarn build

Run your end-to-end tests

yarn test:e2e

Lints and fixes files

yarn lint

Express Installation

See Follow this guide.

Customize configuration

See Configuration Reference.

Project setup using docker

See Docker Container

For Code Style

See Code Stlye