https://github.com/smaug6739/members-api
A members api with Node.JS and MySQL database
https://github.com/smaug6739/members-api
admin-management backend database member-area members mysql nodejs
Last synced: 5 months ago
JSON representation
A members api with Node.JS and MySQL database
- Host: GitHub
- URL: https://github.com/smaug6739/members-api
- Owner: Smaug6739
- License: mit
- Created: 2021-01-28T12:24:40.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-01-12T17:41:50.000Z (almost 4 years ago)
- Last Synced: 2025-02-28T22:12:04.670Z (10 months ago)
- Topics: admin-management, backend, database, member-area, members, mysql, nodejs
- Language: TypeScript
- Homepage:
- Size: 94.7 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Members-API
This repo contains a simple API allowing registration, authentication, updates, deletions and retrievals of members.
## How to install
1. Clone the repo.
2. Install the tools to be able to operate it:
-Nodejs : https://nodejs.org/en/
-MySQL : https://dev.mysql.com/downloads/mysql/
3. In the `src` folder: install dependencies: `npm install`.
4. Edit template.config.ts files.
5. Create the database with the template files in the `database` folder.
6. Compile ts files in javascript with the `tsc` command
8. Start API with `node dist/main.js` command
Following these operations, if the API is functioning correctly, it can be accessed at the address:
http://127.0.0.1:3000 where http://localhost:3000
## Documentation
The documentation is accessible on this repo [via this link](https://github.com/SmaugDev/members-api/tree/master/docs) .
## Contribution
If you want to contribute to the project, report bugs or suggest improvements you can open an issue, contribute forks / pull requests
## Permissions
This project has an MIT license .