Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/shanthi1710/college-project

This is a web application built with React and Javascript to ease and organize the process of placement drives for students of walchand institute of technology solapur. The build tool used is Vite. AntDesign and TailwindCSS are used for the component library and styling, respectively. The server is built using Node.js.
https://github.com/shanthi1710/college-project

bcryptjs context-api expressjs firebase-auth flowbite jwt mongodb node-js reactjs redux socket-io tailwindcss

Last synced: 20 days ago
JSON representation

Host: GitHub
URL: https://github.com/shanthi1710/college-project
Owner: shanthi1710
Created: 2024-05-19T09:05:32.000Z (9 months ago)
Default Branch: main
Last Pushed: 2024-08-11T09:45:07.000Z (6 months ago)
Last Synced: 2024-11-11T22:38:24.495Z (3 months ago)
Topics: bcryptjs, context-api, expressjs, firebase-auth, flowbite, jwt, mongodb, node-js, reactjs, redux, socket-io, tailwindcss
Language: JavaScript
Homepage: https://wit-college.netlify.app/
Size: 493 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# WIT Placement Management Web Application

## Introduction

## Prerequisites

Before running this project, make sure you have the following software installed on your system:

- Node.js (v18.14.2 or higher)
- pnpm (v8.2.0 or higher)

## Installation

**NB:** All the mentioned steps must be done within the main branch only. To get started with the app, you will need to clone this repository and install the dependencies. You can do this by running the following commands in your terminal:

```bash
git clone https://github.com/shanthi1710/college-project
cd college-project
```

In the `client` directory, install client dependencies,

```bash
pnpm install
```

In the `server` directory, install server dependencies,

```bash
pnpm install
```

## Setting Environment Variables

In `client` directory, create a file `.env.local`

From your Firebase console, create a new project and add Firebase to your webapp in the project settings. Collect your web app's Firebase configuration and add the following in the file.

```bash
VITE_APIKEY=*******************
VITE_AUTHDOMAIN=***************
VITE_PROJECTID=****************
VITE_STORAGEBUCKET=************
VITE_MESSAGINGSENDERID=********
VITE_APPID=********************
VITE_SERVER_DOMAIN=http://localhost:5173
```

In server directory, create a file `.env`

Make sure you signup for a Cloudinary account and Mongodb Atlas. Collect the secret keys and urls, and add the following in the file.

```bash
MONGODB_URL=*******************
CLOUDINARY_CLOUD_NAME=*********
CLOUDINARY_API_KEY=************
CLOUDINARY_API_SECRET=*********
JWT_SECRET=********************
CLIENT_DOMAIN=http://localhost:5173
```

JWT_SECRET can be given as a random string of any length. e.g., `JWT_SECRET="vhjsjgdkajbdfsjhfgbdajkfbgadjkfg"`

## Usage

Once you have installed the dependencies and set the environment variables, you can run the server by running the following command from the `server` directory:

```bash
pnpm dev
```

You can then run the client by running the following command from the `client` directory:

```bash
pnpm run dev
```

This will start the client and open the app in your default browser. This may take 2-3 minutes.

**NB: Make sure the server runs in PORT: 3000 and client runs in http://localhost:5173 to avoid any CORS errors**