Skip to content

Latest commit

 

History

History
117 lines (68 loc) · 2.25 KB

README.md

File metadata and controls

117 lines (68 loc) · 2.25 KB
Raw

📖 [MAILBOX APP]

[MAILBOX] is a mail inbox fullstack application built using React.js and Node.js. The app allows users to view their email messages and the app marks the opened messages as read. The app implements an API layer to fetch and update message data stored in a database. The top bar of the app indicates the number of unread messages and the name of the user. The app is styled using CSS. The app uses a predefined user and only shows messages for that user and to that user.

🛠 Built With

  • MongoDB
  • Expres.js
  • React
  • Node.js

Key Features

features:

  • Node provides the backend environment for this application
  • Express middleware is used to handle requests, routes
  • Mongoose schemas to model the application data
  • React for displaying UI components
  1. Login
  2. Homepage
  3. inbox page
  4. Message page
  5. Differentiation of read and unread messages
  6. Text on homepage telling the user the number of unread messages they have

API DOCUMENTATION

https://documenter.getpostman.com/view/25553859/2s935isRVZ

Getting Started

Prerequisites

In order to run this project you need:

  • Node

  • Express

  • Mongoose

  • React

  • Webpack

  • MongoDB

Setup

Clone this repository to your desired folder:

$ git clone https://github.com/NATASHA-ct/MAILBOX-APP.git

Install

Install this project with:

 // go to client folder(frontend)
$ yarn # or npm i    // npm install packages

 // go to server folder(backend)
$ yarn # or npm i    // npm install packages

Usage

To run the project, execute the following command:

In your code editor open 2 terminals one for frontend and one for backend

#### Run the backend
$ cd backend
$ npm run dev

#### Run the frontend
$ cd frontend

$ npm run start

Deployment

To be deployed

using render

👥 Author

👤 NATASHA TATENDA CHIROMBE