yasharth291 / talawa-docs

Documentation for Talawa and Talawa-API

Talawa Docs

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][link] to get started.
• Visit the [Talawa-Docs GitHub][repo] to see the code.

Installation

The contents of the talawa-docs repo is used to automatically create the talawa documentation website. The automation uses Docusaurus, a modern static website generator.

Intallation will vary depending on whether you use the yarn or npm packages. Visit the Docusaurus installation web page if you have any difficulties with the steps below.

Using Yarn

The steps are simple:

1. Clone this repository
2. Install yarn on your system using these instructions
3. Follow these steps next

$ git clone https://github.com/PalisadoesFoundation/talawa-docs
$ cd talawa-docs
$ yarn add docusaurus

Using NPM

Insert documentation here.

Running the Development Server

To preview your changes as you edit the files, you can run a local development server that will serve your website and it will reflect the latest changes.

Using Yarn

Follow these steps:

Note: Install the latest stable version of Nodejs on your system if you get a The engine "node" is incompatible with this module. Expected version message during the procedure below. You may need to use a custom repository for this.

$ sudo apt-get -y install npm
$ sudo npm install --global yarn
$ cd talawa-docs
$ yarn add docusaurus
$ yarn run start

By default, a browser window will open at http://localhost:3000.

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Using NPM

Insert documentation here.

Building Static HTML Pages

In most cases is unnecessary. Running the development server will be sufficient.

If you need to generate static HTML pages (unlikely), then follow these steps.

$ yarn run build

This command generates static content into the /build directory and can be served using any static contents hosting service.