Skip to content

wandersonalwes/nodejs-authentication

Repository files navigation

NodeJS Authentication API

Authentication API built with NodeJS.

Author Languages Stars Forks Contributors

Run in Insomnia}

📌 Table of Contents

👷 Installation

You need to install Node JS and Yarn first, then in order to clone the project via HTTPS, run this command:

git clone https://github.com/wandersonalwes/nodejs-authentication-api.git

SSH URLs provide access to a Git repository via SSH, a secure protocol. If you have a SSH key registered in your Github account, clone the project using this command:

git clone git@github.com:wandersonalwes/nodejs-authentication-api.git

Install dependencies

yarn

Create your enviroment variables based on the examples of .env.example

cp .env.example .env

After copying the examples, make sure to fill the variables with new values.

🏃 Getting Started

Execute the follow command to create tables, relationships and procedures:

yarn migrate

Run the following command in order to start the application in a development environment:

yarn dev

To generate the production version, run the following command.

yarn build

The production files will be in a "/dist" folder at the root of the application.

To start your application in a production environment, run the following command:

yarn start

🐛 Issues

Feel free to file a new issue with a respective title and description on the the NodeJS Authentication API repository. If you already found a solution to your problem, i would love to review your pull request! Have a look at our contribution guidelines to find out about the coding standards.

🎉 Contributing

Check out the contributing page to see the best places to file issues, start discussions and begin contributing.

📕 License

Released in 2020. This project is under the MIT license.

Made with love by Wanderson Alves 💜🚀