forked from Swpn0neel/term-ai-h4b
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
22 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# TermAI | ||
|
||
## Installation Guide | ||
|
||
### Setting up socket server: | ||
- To start socket server go to `server` folder. | ||
- Provide env variables `APP_URL` & `API_URL` for frontend and backend server respectively. | ||
- Run `npm install` or `pnpm install` to install dependencies. | ||
- Start server using `npm run dev` or `pnpm dev` (runs in port `3000` by default). | ||
|
||
Socket server must be running while working with the frontend terminal. | ||
|
||
### Setting up frontend and backend api: | ||
- To start frontend go to `web` folder. | ||
- Create .env file and provide the env variables shown in .env.example file. | ||
- Run `npm install` or `pnpm install` to install dependencies. | ||
- Start server using `npm run dev` or `pnpm dev` (runs in port `4000` by default). | ||
|
||
## Tech Stack | ||
- Typescript, Next.js, Socket.io, MongoDB, Docker, Google Cloud Run |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters