Epic Mail is a web app that lets people exchange messages/information
Epic mail will aid communication between individuals or groups of people
# Get the latest snapshot
git clone https://github.com/Tyak99/Epic_Mail myproject
# Change directory
cd myproject
# Install NPM dependencies
npm install
# Create a .env file to root folder
touch .env
# Add postgres database information
DATABASE_URL=your_database_url
# Then simply start your app
npm run dev
# Enter project directory
cd myproject
# Add test postgres database information
TEST_DATABASE_URL=your_database_url
# Start test
npm test
# Enter project directory
cd myproject
# Start test
npm run build
- Gh-Pages Url
https://tyak99.github.io/Epic_Mail/Ui/Index.html
- Api documentation
https://intense-thicket-60071.herokuapp.com/docs
Back to top
The API is generally RESTFUL and returns results in JSON.
-
api/v1/auth/signup
-
POST
-
{ email, password, firstName, lastName }
-
- Status:
200
- data:
{ token: " " }
- Status:
-
- Status:
400
- error:
"Email already in use"
- error:
"All fields must be present"
- Status:
-
api/v1/auth/login
-
POST
-
{ email: string password: string }
-
- Status:
200
- data:
{ token: " " }
- Status:
-
- Status:
400
- error:
"Invalid email or password"
- Status:
-
api/v1/messages
-
POST
-
{ subject: required message: required emailTo: nullable senderId: nullable parentMessageId: nullable }
-
- Status:
201
- data:
{ id, subject, message, status, createdOn, receiverId, senderId, parentMessageId }
- Status:
-
- Status:
400
- error:
"Please input all required fields"
- Status:
404
- error:
"Email not found"
- Status:
-
api/v1/messages
-
GET
-
receiverId: required
-
- Status:
200
- data:
[ { id, subject, message, createdOn, status, receiverId, senderId, parentMessageId }, ]
- Status:
-
api/v1/messages/sent
-
GET
-
senderId: required
-
- Status:
200
- data:
[ { id, subject, message, createdOn, status, receiverId, senderId, parentMessageId }, ]
- Status:
-
api/v1/messages/:id
-
GET
-
messageId: required
-
- Status:
200
- data:
{ id, subject, message, createdOn, status, receiverId, senderId, parentMessageId },
- Status:
-
- Status:
400
- error:
"Email with id not found"
- Status:
- EmbeddedArtistry ( For pull request template and README format )
- Iros ( For api README guideline)