Revert "ft: Generate API Documentation (#146)" (#159)

* Revert "ft: Generate API Documentation (#146)"

This reverts commit fa2bf88.

* updated .env.example

.env.example

@@ -8,6 +8,8 @@ API_KEY=<api-key-provided-from-sendgrid>
 SENDER_NAME=<Sender name of sendgrid>
 API_KEYS=<api-key-provided-from-google-sheet-api>
 FRONTEND_URL=<Frontend-url-at-which-the-frontend-app-is-running-on>
-SUPER_ADMIN_EMAIL=<super-admin-email>
-JWT_SECRET=<jwt-secret>
-ADMIN_EMAIL=<admin-email>
+PUSHER_APP_ID=<pusher-app-id>
+PUSHER_KEY=<pusher-key>
+PUSHER_SECRET=<pusher-secret>
+PUSHER_CLUSTER=<pusher-cluster>
+Gnews_Api_Key=<gnews-api>

README.md

@@ -1,114 +1,40 @@
-
-# DevPulse Backend
+# atlp-devpulse-bn
 
 ## Introduction
 
-DevPulse is an innovative platform designed to handle ratings for companies in the **Ed-tech** industry, with its first paying customer being **Andela**. It is currently under development using modern web technologies that prioritize speed and security. This repository contains the codebase for the backend part of the platform, which utilizes **GraphQL, Apollo, and MongoDB**.
-
-## Table of Contents
-
-- [Hosted Link](#hosted-link)
-- [Features](#features)
-- [Technologies](#technologies)
-- [Getting Started](#getting-started)
-  - [Prerequisites](#prerequisites)
-  - [Installation](#installation)
-- [Usage](#usage)
-- [API Documentation](#api-documentation)
-- [Contributing](#contributing)
-- [Contact](#contact)
+Pulse is a platform designed to handle ratings for the companies in the **Ed-tech** industries with the its first paying customer being **Andela**. It is currently under development using modern web technologies that prioritize speed and security. This repo holds the codebase for the backend part of the platform which uses **Graphql, Apollo and mongoDB**.
 
 ## Hosted Link
 
-The backend is currently hosted at: [https://atlp-devpulse-bn.onrender.com/](https://atlp-devpulse-bn.onrender.com/)
-
-## Features
-
-- Real-time performance metrics tracking
-- Advanced attendance management
-- Dynamic application cycle overview
-- Secure authentication and authorization
-- Scalable GraphQL API
-
-## Technologies
-
-To successfully navigate and contribute to the codebase, you should have an understanding of the following technologies:
-
-- [GraphQL](https://graphql.org/): A query language for APIs
-- [TypeScript](https://www.typescriptlang.org/): A typed superset of JavaScript
-- [Apollo Server](https://www.apollographql.com/docs/apollo-server/): A GraphQL server
-- [MongoDB](https://www.mongodb.com/): A NoSQL database
-- [Node.js](https://nodejs.org/): A JavaScript runtime
-- [Express](https://expressjs.com/): A web application framework for Node.js
-
-## Getting Started
-
-### Prerequisites
-
-Before running this project, make sure you have the following installed:
+https://andela-devpulse-backend.devpulse.co/
 
-- [Node.js](https://nodejs.org/) (version 14 or later)
-- [Git](https://git-scm.com/)
-- [MongoDB](https://www.mongodb.com/try/download/community) (local installation or a cloud-hosted instance)
+## How to run
 
-### Installation
+To run this project on your local machine make sure that all the following are checked
 
-1. Clone the repository:
-   ```bash
-   git clone https://github.com/atlp-rwanda/atlp-devpulse-bn.git
-   ```
+- [ ] Nodejs installed on your computer ([MacOS](https://nodejs.org/en/download/), [Windows](https://nodejs.org/en/download/), [Linux](https://nodejs.org/en/download/))
+- [ ] Git installed on your computer
 
-2. Navigate to the project directory:
-   ```bash
-   cd atlp-devpulse-bn
-   ```
+Use the following commands to get started with the project
 
-3. Install dependencies:
-   ```bash
-   npm install
-   ```
+```js
+git clone https://github.com/atlp-rwanda/atlp-devpulse-bn.git
+cd atlp-devpulse-bn
+npm install
+npm run dev
 
-4. Set up environment variables:
-   - Copy the `.env.example` file to `.env`
-   - Fill in the required environment variables
 
-5. Start the development server:
-   ```bash
-   npm run dev
-   ```
+### Other scripts and their usages
+- `npm run build` is used to build the production ready version of the projects.
+Used during deployment
 
-## Usage
-
-### Available Scripts
-
-- `npm run dev`: Starts the development server using nodemon
-- `npm start`: Starts the production server
-- `npm test`: Runs the test suite using Jest
-- `npm run build`: Builds the production-ready version of the project using TypeScript compiler
-- `npm run seed`: Runs the database seeding script
-
-## API Documentation
-
-For detailed information about the API endpoints and how to use them, please refer to our [API Documentation](https://atlp-devpulse-bn.onrender.com/graphql).
-
-## Contributing
-
-We welcome contributions to the DevPulse project! Please follow these steps to contribute:
-
-1. Fork the repository
-2. Create a new branch (`git checkout -b feature/AmazingFeature`)
-3. Make your changes
-4. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
-5. Push to the branch (`git push origin feature/AmazingFeature`)
-6. Open a Pull Request
-
-Please make sure to update tests as appropriate and adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
-
-
-## Contact
+## Technologies
 
-DevPulse Team - [[email protected]](mailto:[email protected])
+To successfully navigate the codebase of the project, you will need undertanding
+of the following technologies that are being used to develop this application:
 
-Project Links: 
-- [https://github.com/atlp-rwanda/atlp-devpulse-bn](https://github.com/atlp-rwanda/atlp-devpulse-bn)
-- https://atlp-devpulse-bn.onrender.com/
+- GraphQl
+- Typescript
+- Apollo server
+- MongoDB
+```

package.json

@@ -39,7 +39,6 @@
     "@graphql-tools/merge": "^8.3.7",
     "@sendgrid/mail": "^8.1.3",
     "apollo-server": "^3.10.2",
-    "apollo-server-express": "^3.13.0",
     "axios": "^1.7.7",
     "bcrypt": "^5.1.1",
     "bcryptjs": "^2.4.3",