https://github.com/victorsouza19/user-api
:octocat: RestAPI with Knex.js and JSON Web Token.
https://github.com/victorsouza19/user-api
node nodejs rest rest-api
Last synced: 2 months ago
JSON representation
:octocat: RestAPI with Knex.js and JSON Web Token.
- Host: GitHub
- URL: https://github.com/victorsouza19/user-api
- Owner: victorsouza19
- Created: 2021-11-28T17:53:56.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-12-31T02:19:31.000Z (over 4 years ago)
- Last Synced: 2025-03-24T12:48:18.304Z (over 1 year ago)
- Topics: node, nodejs, rest, rest-api
- Language: JavaScript
- Homepage:
- Size: 43.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# User API
> RestAPI of user manipulation.
### :construction: Recent Features
- [x] UUID to recover token generate.
- [x] NodeMailer to e-mail trigger for password recovery.
- [x] .env file to store the environment variables.
## 💻 Prerequisites
Before start, make sure you meet these requirements:
* You have installed the latest stable version of `node`
* You have installed and configured a `MySQL client`.
## 🚀 Installing and Configuring
To install UserAPI, follow these steps:
Clone the project and run the command in the root directory:
```
npm install
```
Change the file .envexample with your environment variables:
```
## database config
DB_HOST=127.0.0.1
DB_USER=user
DB_PWD=password
DB_NAME=database
## E-mail trigger config
EMAIL_HOST=smtp.gmail.com
EMAIL_PORT=465
EMAIL_USER=youremail@gmail.com
EMAIL_PASSWORD=123456
## if your SMTP server didn't use SSL/TLS put false
EMAIL_SECURE=true
## JWT config
JWT_SECRET=f9f217a18745919771a7936b3a164121a
```
After that, rename the file to .env
## ☕ Using the UserAPI.
Run the server with this line in the command line:
```
node index.js
```
(I recommend `nodemon` to server auto-restart after changes)
Test and enjoy! 😅
## :books: Documentation
To view the API documentation, check the file [DOCUMENTATION](DOCUMENTATION.md).
## 📫 Contributing for this project.
To contribute, follow these steps:
1. Fork this repository.
2. Create a branch with your feature name: `git checkout -b mynewfeature`.
3. Make your changes and confirm: `git commit -m 'messagehere'`
4. Push your change to the original branch: `git push origin mynewfeature`
5. Create the pull request.
Instead, you can check the GitHub documentation [Creating a Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
## 🤝 Contributors
## 📝 License
This project is under license. Check the file [LICENSE](LICENSE.txt) for more details.
[⬆ Go back to the top!](#User-API)
