https://github.com/caioliveira277/treefy-api
The API of an app to help you take care of plants
https://github.com/caioliveira277/treefy-api
nodejs postgresql strapi-cms typescript
Last synced: about 2 months ago
JSON representation
The API of an app to help you take care of plants
- Host: GitHub
- URL: https://github.com/caioliveira277/treefy-api
- Owner: caioliveira277
- License: apache-2.0
- Created: 2022-07-12T22:37:52.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-19T03:21:16.000Z (over 2 years ago)
- Last Synced: 2025-03-29T10:05:01.908Z (2 months ago)
- Topics: nodejs, postgresql, strapi-cms, typescript
- Language: JavaScript
- Homepage: https://treefy-api.herokuapp.com/
- Size: 6 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Treefy - API 🌱
## The plant app ***Fatec - SR TCC***
## Idea: 💡
Develop an app to help grow plants
## Functionalities:
- Register informative content
- Manage user moderator permissions
- Provide an api for viewing content and categories
## Running the project: 🚀
To run and preview the project you will need to follow the next steps.
### Prerequisites:
Below are the necessary tools for the project to work.
- **NodeJS versão 16** 
[Instalation guide NodeJS](https://nodejs.org/en/).
### Installing dependencies:
Run command to install project dependencies.
```sh
npm install
```
### Executing the project:
The scripts below run the project.
```sh
npm run dev # execute in developer mode
npm run build # to build project
```
### Code validation:
The scripts below run prettier and lint.
```sh
npm run lint # run lint validation
```
### Tests:
The scripts below run jest tests.
```sh
Not implemented yet
```
---
## Links: 🌐
[Heroku](https://www.heroku.com/)
[Treefy - API](https://treefy-api.herokuapp.com/api)
[Strapi CMS docs](https://docs.strapi.io/developer-docs/latest/getting-started/introduction.html)
---
## License
This project is licensed under the [APACHE 2.0] license - see the LICENSE file for details