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

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

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/tolumide-ng/maily_fe
• Owner: tolumide-ng
• Created: 2021-05-29T08:49:26.000Z (over 3 years ago)
• Default Branch: develop
• Last Pushed: 2021-06-01T10:17:31.000Z (over 3 years ago)
• Last Synced: 2023-03-06T08:17:25.376Z (almost 2 years ago)
• Language: TypeScript
• Size: 1.21 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Maily FE

## How to Setup this project

### Using your local machine's environment:

--- Prequisites: `at least node version 14, 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 (You could use the deployed backend on heroku as the `BASE_URL: "https://maily-tolu-be.herokuapp.com/"`)

5. Start the project with `npm run dev` to run in development mode

6. To run the production version of the application run

   i. `npm run build`

   ii. `npm run start`

   iii. Open you browser and checkout `http://localhost:8080/`

### 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:

   i. Your `BASE_URL` should be: `http://localhost:9000/` (check the docker-compose.yml file to see why),

   ii. 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:50000`

6. To shut down the application

   i. `CMD + C `

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

Enter your "yahoo" associated email address and password to access your mails

Checkout how to generate passwords for third party applications on [yahoo](https://help.yahoo.com/kb/generate-third-party-passwords-sln15241.html)

## Subtle Notes:

Refreshing the application would cause you to lose your authentication. Hence you would need to reconnect to access your mails.