> For the complete documentation index, see [llms.txt](https://simpletut.gitbook.io/universal-react-redux-registration/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://simpletut.gitbook.io/universal-react-redux-registration/master.md).

# Getting Started

This documentation will cover the installation on your localhost machine, project architecture and working with the app in general.

The registration system includes both a Backend API written using NodeJS & MongoDB and a Frontend written as a Universal React Redux App.

**Demo:** [**Link**](https://react-redux-reg.herokuapp.com/)

**Github Project Repository:** [**Link**](https://github.com/simpletut/Universal-React-Redux-Registration)

![Screenshot - Registration Page includes async validation (Redux-Form)](/files/-LNfi0kyRhMTHUz9Uebf)

#### Front includes:

Registration, Login, Dashboard, Email Password, Logout

Account Update, 404 (Not Found)

The User Registration System is **Fully Responsive** out the box and you can **Restrict Access** to any page!

#### Tech Stack:

* NodeJS
* React
* Server-side Rendered
* Redux
* Redux-Thunk
* Redux-Form
* MongoDB
* Mongoose
* JSON Web Tokens
* Webpack 4
* Babel 7
* Express
* SASS

#### Top Features:

* Async Validation (Redux-Form)
* Winston - Better error handling/logging
* Bcrypt password encryption/verification
* Nodemailer – Custom mail server used to send password reset emails
* Custom ‘Password Reset’ Template (Built with MJML Framework)
* Multiple Layouts – Create unlimited layouts for pages/routes
* Unit Tests
* Toastr - Simple javascript toast notifications
* 100% FREE & Open Source

### Software

Before proceeding, please ensure you have the following software installed on your computer.

* Node
* Yarn (optional but recommended)
* Git command line tools

#### Useful links

* Download Git CLT - Windows: <https://git-scm.com/download/windows> Mac: <https://git-scm.com/download/mac>
* Download Node - <https://nodejs.org/en/>
* Download Yarn CLT - <https://yarnpkg.com/lang/en/docs/install/>
* Download VSCode - <https://code.visualstudio.com/>

### Acknowledgements

This software was developed by Ashley Bibizadeh.

### License

The User Registration System is open source software licensed as MIT.