This project is a full-stack Library Management System with separate client and server components.
The project is divided into two main folders:
The client-side of the application is built using modern web technologies.
- React.js
- TypeScript
- Redux (for state management)
- Tailwind CSS (for styling)
-
Navigate to the client directory:
cd client
-
Install dependencies:
npm install
-
Start the development server:
npm run dev
The server-side of the application handles the backend logic and database operations.
- Node.js
- Express.js
- TypeScript
- MongoDB (assumed based on typical MERN stack)
-
Navigate to the server directory:
cd server
-
Install dependencies:
npm install
-
Start the server:
npm start
As outlined in the server's README:
- Create Interfaces
- From interfaces, create Schemas
- From Schemas, create Models
- From Models, create Queries
Both client and server directories contain configuration files for:
- ESLint
- Prettier
- TypeScript
Ensure to review and adjust these configurations as needed for your development environment.
The server directory includes a vercel.json
file, indicating that the project is set up for deployment on Vercel.
Contributions to the project are welcome. Please ensure to follow the existing code style and add unit tests for any new features.
This project is open source. Please refer to the LICENSE file in the repository for more information.