Go to the link for the UI-Preview: fronend/README.md
Screen.Recording.2024-03-29.at.11.30.52.PM.mov
- Clone the repository
git clone https://github.com/sayakghorai34/Library-Management-System.git
- Open the terminal and navigate to the project directory
cd Library-Management-System
- Go to
backend
directory and install dependencies
cd backend
npm install
- Locate and rename the
.env.example
file in thebackend
to.env
and add the following environment variables
PORT=define any suitable port
MONGODB_URI=your mongodb connection string
- Run the following command to start the server
npm start
- Go to the
frontend
directory and install the dependencies
cd frontend
npm install
- rename the
.env.example
file in thefrontend
to.env
and add the following environment variables:
REACT_APP_API_URI=http://localhost:<port>/api
(Note: the URI should end with /api
. Else The below modification needs to be done on the backend/server.js
)
app.use('/api/books', bookRoutes); //replace these /api with your URI trailer
app.use('/api/borrowers', borrowerRoutes); //replace these /api with your URI trailer
app.use('/api/authors', authorRoutes); //replace these /api wwith your URI trailer
app.use('/api/counts', countRoutes); //replace these /api wwith your URI trailer
- Run the following command to start the client
npm start
- Open the browser and navigate to
http://localhost:3000/
to view the client
- Test(useless).js is just a checking file to see if the server is running or not. It is not a part of the project
- Run the server before running the client(else the client will not fetch data until the server is running)
- The project is still under development and some features may not work as expecte
- the
npm start
command will start the server using nodemon. To change the behaviour, change thestart
script inpackage.json
file in thebackend
directory - The project is still under development and hence the Demo UI or the video may not be exact same as the current UI
- Sayak Ghorai (github/sayakghorai34), 29th May 2024