Simple-Register

Table of contents

• About the project
• Description
• Built with
• Installation
• Run
• Notes
• License

About the project

Simple-Register is a simple project that I created as an example to my bro Endizera.

Description

This project basically contains:

• Mailtrap as a mailer to safe e-mail testing for staging and development
• RFC-7807 (problem detail) to format response errors
• MongoDB as a principal database
• Simple flux to register a user, authenticate, reset the password, and view the last change of password utilizing token generated by authenticating route

Built with

• Express
• Mongoose

Installation

1. To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Git CLI
git clone https://github.com/zevolution/simple-register.git

# Github CLI
gh repo clone zevolution/simple-register

2. Install NPM Packages

npm install

3. Configure the environment properties. The settings below must be added in a .env file.

# MongoDB Configurations
SR_MONGO_URL=

# MailTrap Configurations
SR_MAIL_HOST=
SR_MAIL_PORT=
SR_MAIL_USER=
SR_MAIL_PASSWORD=
SR_MAIL_SENDER=

Run

Use the package manager npm to run Simple-Register.

npm run dev

Notes

MongoAtlas

You can use MongoAtlas as a cloud database service. They provide a free database in a shared cluster of up to 512MB.

Insomnia File

You can import simple-register-api-insomnia.json to use the API.

Node Version

This project was created using node version 10.16.0.

License

MIT