Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/krishmakhijani/proactively
https://github.com/krishmakhijani/proactively
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/krishmakhijani/proactively
- Owner: krishmakhijani
- Created: 2024-12-06T20:19:15.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-08T12:38:52.000Z (2 months ago)
- Last Synced: 2024-12-08T13:28:44.640Z (2 months ago)
- Language: TypeScript
- Size: 331 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Proactively - Assignment
## Preview
> [!WARNING]
> Made ```.env``` files public for the convenience of the reviewer. This is not recommended in a production environment.
## Tech Stack
### Backend
- Node.js
- Express
- Prisma
- TypeScript
- PostgreSQL (Database)
### Frontend
- Next.js
- React
- Tailwind CSS
### Prerequisites
- Node.js (v14 or higher)
- npm (v7 or higher)
- pnpm (v6 or higher)(recommended)
### Installation Steps
1. Clone the repository:
```sh
git clone https://github.com/krishmakhijani/proactively.git
cd proactively
```
2. Install Backend Dependencies
```sh
cd backend
npm install
npx prisma generate
```
3. Install Frontend Dependencies
```sh
cd frontend
npm install
```
4. Start the Backend Server
```sh
cd backend
npm run dev
```
5. Start the Frontend Server
```sh
cd frontend
npm run dev
```
6. Open [http://localhost:3001](http://localhost:3001) in your browser to see the frontend.
> [!NOTE]
> Step 5 and Step 6 should be run in separate terminals but both processes should be running simultaneously.
8. Backend running on [http://localhost:3000](http://localhost:3000).
9. To see the Database open [http://localhost:5555](http://localhost:5555) in your browser.
## API Testing Steps
You can test the API using Postman. Import the following Postman collection to get started:
1. Copy the given json link : ```https://raw.githubusercontent.com/krishmakhijani/proactively/refs/heads/main/krishmakhijani.json```
2. Open Postman
3. Click on Import
4. Paste the copied link
[Preview](https://github.com/user-attachments/assets/4dd60de9-4f2d-4088-a2c7-3424a039b233)