Valimp / M1-typescript-api

☘️ Typescript project - M1 Web Development

🔍 About the project

Objectives of this api is to learn about plants. 🌱🫶🏻

There names, scientific names, and more informations. 🔬

And then make theme attractive for most of people. 🧲

💾 How to install the project ?

☘️ Trefle.io API

1. Go to Trefle.io and create an account : Trefle.io website

2. Generate and keep your API key.

☁ GitHub project

1. Go to GitHub repository : GitHub Repository

2. Clone the project : git clone https://github.com/Valimp/M1-typescript-api.git

3. Open the repository : cd M1-typescript-api

4. Install dependencies : npm install

5. (optional) Create .env file : mkdir .env

6. Put your api key in the .env file or in the const/config.ts file.

7. Start nodemon server : npm start

8. Congratulation ! 🎇

🫂 How to contribute

Please, check the api documentation of trefle.io : Get started

Then, check the project api documentation This link works only if your api port is 3000.

If that don't work, go to localhost:[your port]/api-docs

Now we can start :

1. Check if the repository have some issues to fix : API issues

2. Pick one and create your own branch.

3. Please ensure your code is cleaner as possible and use swagger documentation.

4. Please use these prefix for your commits : fix, feat, doc

5. When you fix the issue. You can make a pull request.

Thank you !