Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sreehari2003/kseb
A project management tool for goverment offices
https://github.com/sreehari2003/kseb
docker gin golang nextjs postgresql supertokens typescript
Last synced: 2 months ago
JSON representation
A project management tool for goverment offices
- Host: GitHub
- URL: https://github.com/sreehari2003/kseb
- Owner: sreehari2003
- License: mit
- Created: 2023-01-20T08:16:31.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-13T12:16:18.000Z (11 months ago)
- Last Synced: 2024-10-02T05:23:07.674Z (3 months ago)
- Topics: docker, gin, golang, nextjs, postgresql, supertokens, typescript
- Language: TypeScript
- Homepage: https://suraksha.vercel.app
- Size: 63.1 MB
- Stars: 10
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.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]
#
KSEB
We ensure security for kseb workers from their on-Site working environment
Table of Contents
## About The Project
This is a mobile App for kseb workers to ensure thier security from human errors on site
### Built With
- [NEXT JS](https://nextjs.org/)
- [Go-Lang](https://go.dev/)
- [Gin](https://gin-gonic.com/)
- [Typescript](https://www.typescriptlang.org/)
- [PostreSQL](https://www.postgresql.org/)
- [Go-ORM](https://gorm.io/)
## Images
## Getting Started
### Prerequisites
You need to install
1. [Node v16](https://nodejs.org/en/)
2. [Yarn](https://yarnpkg.com/)
3. [GO lang](https://go.dev/)
### Installation
1. Clone the repo
```sh
git clone https://github.com/sreehari2003/kseb.git
```
2. Install all the NPM packages all the applications.
> We are using Yarn for react native
```sh
yarn install
# for running the website
cd web
yarn 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:8080`
```sh
go run main.go
```
5. Start the Web application
```sh
cd web
yarn run dev
```
6. For GO HOT RELOAD
```sh
nodemon --exec go run main.go --signal SIGTERM
```
### Swagger
Install dependencies:
`go get`
Generate the Swagger documentation:
```
swag init
```
### 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
### Misc Commands
1. Run lint
```sh
yarn lint
```
2. Run lint with autofixable fixes
```sh
yan 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/sreehari2003/kseb.svg?style=for-the-badge
[contributors-url]: https://github.com/sreehari2003/kseb/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/sreehari2003/kseb.svg?style=for-the-badge
[forks-url]: https://github.com/sreehari2003/kseb/network/members
[stars-shield]: https://img.shields.io/github/stars/sreehari2003/kseb.svg?style=for-the-badge
[stars-url]: https://github.com/sreehari2003/kseb/stargazers
[issues-shield]: https://img.shields.io/github/issues/sreehari2003/kseb.svg?style=for-the-badge
[issues-url]: https://github.com/sreehari2003/kseb/issues
[license-shield]: https://img.shields.io/github/license/sreehari2003/kseb.svg?style=for-the-badge
[license-url]: https://github.com/sreehari2003/kseb/blob/main/LICENCE