Smaug6739 / members-api

A members api with Node.JS and MySQL database

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

7. 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 .

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 .