An open API service indexing awesome lists of open source software.

https://github.com/amitjimiwal/sight-backend

Backend for TypeSight
https://github.com/amitjimiwal/sight-backend

authentication-backend express nodejs opencv postgresql prisma typpes

Last synced: about 2 months ago
JSON representation

Backend for TypeSight

Awesome Lists containing this project

README

        

sight-backend

project-image

Backend Server for Typesight

🛠️ Installation Steps:

1. Since we are using submodules for integrating backend and the eyedetection you need to run the following command

```
git submodule init
```

2. Update the submodules with the latest commit

```
git submodule update
```

3. Start backend server

```
cd sight-backend/
```

4. Go through env.sample file create a .env.local file and add all the corresponding environment variables in your local setup. You can go through this video [Hitesh Youtube Video](https://youtu.be/vJLW3S_97aQ?si=_mNJN6YQet0rz5nw)

5. Start the application

```
npm install && npm run dev
```

Run locally using Docker


1. Run Postgress db using docker-compose.yml

```
docker compose up
```

2. Create and edit .env file


3. Build Image from Dockerfile and create an image

```
docker built -t typesightdb .
docker run -it --rm -p --env-file .env -p 5555:5555 typesightdb
```

💻 Built with

Technologies used in the project:
* Nodejs
* Express
* Typescript
* Stripe

🛡️ License:

This project is licensed under the The ReadLogs Project is licensed under the [MIT License](https://opensource.org/licenses/MIT). Feel free to use modify and distribute the software as per the terms of the license.

💖Like my work?

Do gove a ⭐️ to the Repository. Thank you for taking an interest! If you encounter any issues have suggestions or want to report a bug feel free to create an issue on the [GitHub repository](https://github.com/amitjimiwal/sight-backend). Happy Coding!