https://github.com/reenphygeorge/sjcet-labs
A software that assists college faculties to maintain and manage the laboratory.
https://github.com/reenphygeorge/sjcet-labs
capacitorjs chakra-ui docker express nextjs prisma supabase-auth typescript
Last synced: over 1 year ago
JSON representation
A software that assists college faculties to maintain and manage the laboratory.
- Host: GitHub
- URL: https://github.com/reenphygeorge/sjcet-labs
- Owner: reenphygeorge
- License: mit
- Created: 2023-04-04T13:16:05.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-04T07:06:05.000Z (almost 3 years ago)
- Last Synced: 2025-02-28T11:22:55.923Z (over 1 year ago)
- Topics: capacitorjs, chakra-ui, docker, express, nextjs, prisma, supabase-auth, typescript
- Language: TypeScript
- Homepage:
- Size: 538 KB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
Lab Management System
Bookings, Reports, Seat allocations and much more!!
Table of Contents
## About The Project
A software that assists college faculties to maintain and manage the laboratory.
### Built With
- [ExpressJS](https://expressjs.com/)
- [Prisma](https://www.prisma.io/)
- [Next.js](https://nextjs.org/)
- [ChakraUI](https://chakra-ui.com/)
- [Supabase Auth](https://supabase.com/docs/guides/auth)
- [CapacitorJS](https://capacitorjs.com)
## Getting Started
### Prerequisites
You need to install
1. [Node v18](https://nodejs.org/en/)
2. [pnpm](https://pnpm.io/)
### Installation
1. Clone the repo
```sh
git clone https://github.com/reenphygeorge/sjcet-labs.git
```
2. Install all the NPM packages all the applications.
> We are using PNPM workspace and turborepo to manage the applications in monorepo.
```sh
pnpm install
```
3. Copy the `.env.example` for each applications to `.env` in the same directory and fill the values required
4. Start the api dev server and open `http://localhost:8000`
```sh
pnpm --filter api dev
```
5. Start the web application dev server and open `http://localhost:3000`
```sh
pnpm --filter web dev
```
6. Build & export static content
```sh
pnpm --filter web static
```
7. Sync changes with capacitor
```sh
pnpm --filter web cap-sync
```
8. Open `android` directory in Android-Studio & `ios` directory in XCode to build the gradle.
### Installation with Docker compose
| Not ready yet. Coming soon
1. You need to install
- [Docker](https://www.docker.com/) / [Podman](https://podman.io/)
- [Docker Compose](https://docs.docker.com/compose/)
2. Run
```sh
docker-compose up
```
## Command Center
All the commands for applications can be executed from the root directory using PNPM Workspace and Turborepo.
1. Web application PNPM commands
```sh
pnpm --filter web
```
2. API Server PNPM commands
```sh
pnpm --filter api
```
3. Turbo Pipeline Commands
```sh
pnpm turbo run
```
4. Package installation command
```sh
pnpm add "package-name" --filter "workspace-name"
```
### Misc Commands
1. Run lint
```sh
pnpm lint
```
2. Run lint with autofixable fixes
```sh
pnpm lint-fix
```
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
[contributors-shield]: https://img.shields.io/github/contributors/reenphygeorge/sjcet-labs.svg?style=for-the-badge
[contributors-url]: https://github.com/reenphygeorge/sjcet-labs/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/reenphygeorge/sjcet-labs.svg?style=for-the-badge
[forks-url]: https://github.com/reenphygeorge/sjcet-labs/network/members
[stars-shield]: https://img.shields.io/github/stars/reenphygeorge/sjcet-labs.svg?style=for-the-badge
[stars-url]: https://github.com/reenphygeorge/sjcet-labs/stargazers
[issues-shield]: https://img.shields.io/github/issues/reenphygeorge/sjcet-labs.svg?style=for-the-badge
[issues-url]: https://github.com/reenphygeorge/sjcet-labs/issues
[license-shield]: https://img.shields.io/github/license/reenphygeorge/sjcet-labs.svg?style=for-the-badge
[license-url]: https://github.com/reenphygeorge/sjcet-labs/blob/main/LICENCE