https://github.com/tolumide-ng/maily_be

https://github.com/tolumide-ng/maily_be

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/tolumide-ng/maily_be
• Owner: tolumide-ng
• Created: 2021-05-25T21:44:38.000Z (over 3 years ago)
• Default Branch: develop
• Last Pushed: 2021-06-01T04:33:57.000Z (over 3 years ago)
• Last Synced: 2023-03-06T08:17:25.338Z (almost 2 years ago)
• Language: TypeScript
• Size: 88.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
## Maily BE

### Endpoints

| #   | Description               | Endpoint   | Request Body                         | Request Header |

| --- | ------------------------- | ---------- | ------------------------------------ | -------------- |

| 1   | Get all user Emails       | `/all`     | email, password, encType, serverType | NA             |

| 2   | Get a Specific user Email | `/one/:id` | encType, serverType                  | userKey        |

## How to Setup this project

### Using your local machine's environment:

--- Prequisites: Have `node, npm` installed on your local machine

1. Clone the repository

2. Cd into the project

3. Run `npm install` to install all packages

4. Create you local `.env` file and Add Environment variables as listed on the `.env.sample` file (It is compulsory that each of the keys have an exact length of 16)

5. Start the project with `npm run dev` to run in development mode: checkout `localhost:4000`

6. To run the production version of the application run `npm run start`: checkout `localhost:4000`

7. The available endpoints of the application are documented above

### Using the application with docker

-- Prerequisites: `docker, docker-compose`

1. Clone the repository

2. Cd into the application

3. Create a local `.env` file and Add Environment variables as listed on the `.env.sample` file (Your `BASE_URL` should be: `http://localhost:9000/` (check the docker-compose.yml file to see why)):

   i. It is compulsory that each of the keys (i.e AES_KEY & IV_KEY) have an exact length of 16

4. Run `docker compose up` or `docker-compose up`

5. Open your browser and checkout `http://localhost:9000`

6. To shut down the application

   i. `CMD + C `

   ii. `docker compose down` or `docker-compose down`