API-GENERATOR

A simple tool for installing a basic API REST

Table of Contents

1. About The Project
   • Technology used
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contribuer
6. License
7. Contact

About The Project

Cet outil vous permet de générer de manière rapide et simplement un base de structure API REST utilisant les technologies NodeJS, Express, MongoDB.

Une interface vous demandera deux informations :

• Une clé secrete qui sera utilisé pour générer les tokens d'authentification
• L'adresse de connexion à votre base de données MongoDB

Features :

• SignUp, SignIn
• GetAllUsers, GetOneUser

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• NodeJS

(back to top)

Getting Started

Voici les instructions à suivre afin d'utiliser cet outil.

Prerequisites

Get the latest version of npm

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/OualiS/api-generator.git

2. Install NPM packages

   npm install

3. Install the script globally

   npm install -g

4. Run the script in the folder you want the api

   api-generator

(back to top)

Usage

(back to top)

Roadmap

• Multi-OS Support
  • Windows
  • Linux
  • Mac
• Multi-language Support
  • French
  • English
• HTTPS support

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

d3Ex2

(back to top)