https://github.com/tidbitsjs/plantae
https://github.com/tidbitsjs/plantae
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tidbitsjs/plantae
- Owner: TidbitsJS
- Created: 2022-04-26T18:30:10.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-06-02T18:15:31.000Z (about 4 years ago)
- Last Synced: 2025-04-02T20:39:14.629Z (about 1 year ago)
- Language: TypeScript
- Size: 136 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Plants API
A REST API created using Node.js & TypeScript. It does all CRUD operations to manage a plant database. The primary purpose of the project is to get familiarized with developing the backend with TypeScript.
GraphQL Version of the API is [here](https://github.com/TidbitsJS/PlantQL)
A specific plant has following properties:
* Name
* Scientific Name
* Family
* Description
* userId
A specific user has following properties:
* Name
* Username
* Email
* Password
* Plants ( Created )
#
### Setup
Project requirements
- git
- NodeJS
- NPM
- nodemon
**nodemon** is a tool that helps develop node. js based applications by automatically restarting the node application when file changes in the directory are detected.
To verify the installation of above, you can run this:
```shell
git --version
node --version
npm --version
nodemon --version
```
After you've made sure to have the correct things installed, you should be able to just run a few commands to get set up:
1. Clone the repo
```shell
git clone https://github.com/TidbitsJS/plantae.git
cd plantae
```
2. Install node modules
```shell
npm install
```
3. Setup a new project on [MongoDB](https://www.mongodb.com/) platform
4. Store the MonoDB URL in env file
```text
MONGO_URL=mongodb+srv://:@cluster0.eqcqa.mongodb.net/plants?retryWrites=true&w=majority
```
#
### Running the App
To run the app, run the command:
```shell
npm start
```
To run the app in debug mode, run the command:
```shell
npm run debug
```
Local server will start running on the port 4040