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. 🧲
-
Go to Trefle.io and create an account : Trefle.io website
-
Generate and keep your API key.
-
Go to GitHub repository : GitHub Repository
-
Clone the project :
git clone https://github.com/Valimp/M1-typescript-api.git
-
Open the repository :
cd M1-typescript-api
-
Install dependencies :
npm install
-
(optional) Create .env file :
mkdir .env
-
Put your api key in the .env file or in the
const/config.ts
file. -
Start nodemon server :
npm start
-
Congratulation ! 🎇
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 :
-
Check if the repository have some issues to fix : API issues
-
Pick one and create your own branch.
-
Please ensure your code is cleaner as possible and use swagger documentation.
-
Please use these prefix for your commits : fix, feat, doc
-
When you fix the issue. You can make a pull request.
Thank you !