Inbox App

This email app offers a user-friendly interface and powerful features for efficient email management. With advanced filtering, labeling, and search capabilities, you can easily organize and find your emails. Additionally, this app offers seamless integration with other productivity tools.

Table of Contents

• Inbox App
  • Table of Contents
  • Getting Started
  • Database Setup
  • Installation
  • Contributing
  • License
  • Beta Version
  • Built With

Getting Started

To get started with the project, follow these steps:

Clone the repository to your local machine.
Install the dependencies using npm install.
Set up a PostgreSQL database.
Set up a Redis and run the server.
Run the database migrations using npm run migrate:up.
Start the backend server using npm start.
Start the frontend server using npm run dev
Navigate to http://localhost:3000 in your web browser.

Database Setup

1. Create a new PostgreSQL database named inbox_app.
   • CREATE DATABASE inbox_app;
2. Run the following commands to create a new PostgreSQL user:
   • CREATE ROLE admin WITH LOGIN PASSWORD 'admin';
   • ALTER ROLE admin SUPERUSER CREATEROLE CREATEDB;
   • GRANT ALL PRIVILEGES ON DATABASE inbox_app TO admin;

Installation

1. Clone the repository to your local machine.
2. Navigate to the project directory and run npm install or yarn to install dependencies.
3. Start the API in dev mode with npm run dev or yarn dev.
4. Without closing the terminal, navigate to the frontend directory with cd frontend.
5. Run npm install or yarn to install frontend dependencies.
6. Start the frontend server with npm run start or yarn start.

Note: The .env.example file contains environment variables that are used by the application to connect to the database and Redis server, as well as the session secret key. Please review the file carefully before using it, and make any necessary changes to ensure that it works with your specific environment.

To ensure that your application functions correctly, please follow these steps:

1. Rename the .env.example file to .env. The .env file is where you will store your actual environment-specific configuration.

2. Open the newly renamed .env file in a text editor.

3. Go through each environment variable defined in the .env file and review its value. Modify the values as needed to match your database connection details, Redis server configuration, and session secret key requirements.

4. Take special care to ensure that the database connection details, such as the host, port, database name, username, and password, are correctly set according to your database setup. Make sure these values accurately reflect your database configuration to establish a successful connection.

5. Save the changes to the .env file.

Contributing

To contribute to this project, follow these steps:

1. Fork this repository.
2. Create a branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your changes to your fork.
5. Submit a pull request to this repository.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Beta Version

This project is still in beta version and is not yet ready for production use. There may be bugs, incomplete features, or other issues that need to be addressed. Use at your own risk and please report any issues you encounter.

Built With

• React - Single Page Application Library
• Node.js - JavaScript Runtime
• Express - JavaScript API Framework
• Redis - In-Memory Data Store
• PostgreSQL - Open Source Relational Database