forked from PalisadoesFoundation/talawa-admin
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PalisadoesFoundation#2970: autoGen-talawa-admin-docs-debugging
- Loading branch information
Showing
3 changed files
with
20 additions
and
55 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,53 +1,10 @@ | ||
talawa-admin / [Modules](modules.md) | ||
# Documentation for Talawa Admin | ||
|
||
# Talawa Admin | ||
This is the documentation for the Talawa Admin web application. | ||
|
||
💬 Join the community on Slack. The link can be found in the `Talawa` [README.md](https://github.com/PalisadoesFoundation/talawa) file. | ||
The Talawa Admin application is a web application that provides a user interface for the Talawa Foundation's administrative tasks. | ||
|
||
![talawa-logo-lite-200x200](https://github.com/PalisadoesFoundation/talawa-admin/assets/16875803/26291ec5-d3c1-4135-8bc7-80885dff613d) | ||
This documentation is split into two main sections: | ||
|
||
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) | ||
[![GitHub stars](https://img.shields.io/github/stars/PalisadoesFoundation/talawa-admin.svg?style=social&label=Star&maxAge=2592000)](https://github.com/PalisadoesFoundation/talawa-admin) | ||
[![GitHub forks](https://img.shields.io/github/forks/PalisadoesFoundation/talawa-admin.svg?style=social&label=Fork&maxAge=2592000)](https://github.com/PalisadoesFoundation/talawa-admin) | ||
[![codecov](https://codecov.io/gh/PalisadoesFoundation/talawa-admin/branch/develop/graph/badge.svg?token=II0R0RREES)](https://codecov.io/gh/PalisadoesFoundation/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](http://www.palisadoes.org/) for more details on its origin and activities. | ||
|
||
# Table of Contents | ||
|
||
\<!-- toc --\> | ||
|
||
- [Talawa Components](#talawa-components) | ||
- [Documentation](#documentation) | ||
- [Installation](#installation) | ||
|
||
\<!-- tocstop --\> | ||
|
||
# Talawa Components | ||
|
||
`talawa` has these major software components: | ||
|
||
1. **talawa**: [A mobile application with social media features](https://github.com/PalisadoesFoundation/talawa) | ||
1. **talawa-api**: [An API providing access to user data and features](https://github.com/PalisadoesFoundation/talawa-api) | ||
1. **talawa-admin**: [A web based administrative portal](https://github.com/PalisadoesFoundation/talawa-admin) | ||
1. **talawa-docs**: [The online documentation website](https://github.com/PalisadoesFoundation/talawa-docs) | ||
|
||
# Documentation | ||
|
||
- The `talawa` documentation can be found [here](https://docs.talawa.io). | ||
- Want to contribute? Look at [CONTRIBUTING.md](https://github.com/PalisadoesFoundation/talawa-admin/blob/develop/CONTRIBUTING.md) to get started. | ||
- Visit the [Talawa-Docs GitHub](https://github.com/PalisadoesFoundation/talawa-docs) to see the code. | ||
|
||
# Installation | ||
|
||
[Follow this guide](https://github.com/PalisadoesFoundation/talawa-admin/blob/develop/INSTALLATION.md) | ||
- User Guide : This section provides a guide for users of the Talawa Admin application. It covers the different features of the application and how to use them. | ||
- Developer Guide : This section provides a guide for developers who want to contribute to the Talawa Admin application. It covers the technical details of the application and how to set it up for development. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters