https://github.com/zevolution/simple-register
This application has a simple flux to registration a user, authenticate and reset the password
https://github.com/zevolution/simple-register
crud-api crud-application crud-sample example examples express javascript mail mailer mongo mongoatlas mongoose node node-js nodejs register rfc
Last synced: 9 months ago
JSON representation
This application has a simple flux to registration a user, authenticate and reset the password
- Host: GitHub
- URL: https://github.com/zevolution/simple-register
- Owner: zevolution
- Created: 2020-05-24T15:51:15.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-22T16:46:27.000Z (about 3 years ago)
- Last Synced: 2025-01-25T17:33:20.232Z (11 months ago)
- Topics: crud-api, crud-application, crud-sample, example, examples, express, javascript, mail, mailer, mongo, mongoatlas, mongoose, node, node-js, nodejs, register, rfc
- Language: JavaScript
- Homepage:
- Size: 259 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Simple-Register
## Table of contents
- [About the project](#about-the-project)
- [Description](#description)
- [Built with](#built-with)
- [Installation](#instalation)
- [Run](#run)
- [Notes](#notes)
- [License](#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](https://mailtrap.io/) as a mailer to safe e-mail testing for staging and development
* [RFC-7807](https://tools.ietf.org/html/rfc7807) (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:
```sh
# Git CLI
git clone https://github.com/zevolution/simple-register.git
# Github CLI
gh repo clone zevolution/simple-register
```
2. Install NPM Packages
```sh
npm install
```
3. Configure the environment properties. The settings below must be added in a `.env` file.
```properties
# 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](https://www.npmjs.com/) to run Simple-Register.
```bash
npm run dev
```
## Notes
### MongoAtlas
You can use [MongoAtlas](https://www.mongodb.com/pricing) 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](https://gist.github.com/zevolution/6f469ba51e03ae4e5215dc06f63d60e2) to use the API.
### Node Version
This project was created using node version `10.16.0`.
## License
[MIT](https://choosealicense.com/licenses/mit/)