Rithingithub / kseb

Ktu btech mini project for kerala state electric board

KSEB Platform

We ensure security for kseb workers from their on-Site working environment

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation

About The Project

This is a mobile App for kseb workers to ensure thier security from human errors on site

(back to top)

Built With

• NEXT JS
• Go-Lang
• Gin
• Typescript
• PostreSQL
• Go-ORM

(back to top)

Getting Started

Prerequisites

You need to install

1. Node v16
2. Yarn
3. GO lang

Installation

1. Clone the repo

   git clone https://github.com/sreehari2003/kseb.git

2. Install all the NPM packages all the applications.

   We are using Yarn for react native

   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

   go run main.go

5. Start the Web application

   cd web
   yarn run dev

6. For GO HOT RELOAD

     nodemon --exec go run main.go --signal SIGTERM

Swagger

Install dependencies: go get Generate the Swagger documentation:

swag init

(back to top)

Installation with Docker compose

| Not ready yet. Coming soon

1. You need to install

• Docker / Podman
• Docker Compose

2. Run

docker-compose up

(back to top)

Command Center

Misc Commands

1. Run lint

     yarn lint

2. Run lint with autofixable fixes

     yan lint-fix

(back to top)

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

(back to top)