https://github.com/codewithveek/phozy-api
A Photo sharing API built with NodeJS, Typescript and PlanetScale DB
https://github.com/codewithveek/phozy-api
api-rest image nodejs-api planetscale
Last synced: 7 days ago
JSON representation
A Photo sharing API built with NodeJS, Typescript and PlanetScale DB
- Host: GitHub
- URL: https://github.com/codewithveek/phozy-api
- Owner: codewithveek
- Created: 2022-07-20T10:58:18.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-10-09T19:59:04.000Z (over 3 years ago)
- Last Synced: 2026-02-04T14:37:17.749Z (4 months ago)
- Topics: api-rest, image, nodejs-api, planetscale
- Language: TypeScript
- Homepage:
- Size: 5.56 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# phozy-api
A Photo sharing API built with NodeJS, Typescript and PlanetScale DB
## How to use
clone the repo `git clone https://github.com/Lucky-victory/phozy-api.git`
move into the directory `cd phozy-api`
copy the `.env.example`
`cp .env.example .env`
fill in the following fields
```shell
DATABASE_URL= // your planetscale db url
JWT_SECRET_KEY
CLOUDINARY_URL= // ypur cloudinary url
```
then install dependencies, initialized the database and start the server
```shell
npm install
npm run db:init
npm run start
```
### Routes
General route `/api`
Sign up route `/api/sign-up`
Sign in route `/api/sign-in`
User's route `/api/profile`
Album's route `/api/profile`
Photos's route `/api/photos`
Likes route `/api/likes`
## Ref
This project was built for Planetscale X Hashnode hackathon