From 37f9b2634eb35c2ae407034ed47e2e49a95a73ed Mon Sep 17 00:00:00 2001 From: Shreyas Hegde Date: Mon, 12 Jan 2026 22:53:30 +0530 Subject: [PATCH] docs: Updated Readme.md --- README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 59 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b9e40af..42f15c3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,49 @@ +# PB Recruitment Server + +A server-side application for managing recruitment workflows and processes for the PointBlank Club. + +## Features + +- Candidate application management +- Review and evaluation tools +- User/admin authentication +- RESTful API for integrations + +## Prerequisites + +- [Node.js](https://nodejs.org/) >= 16.x +- [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/) + +## Getting Started + +Clone the repository: + +```bash +git clone https://github.com/pointblank-club/pb-recruitment-server.git +cd pb-recruitment-server +``` + +Install dependencies: + +```bash +npm install +# or +yarn install +``` + +Configure environment variables: + +1. Copy `.env.example` to `.env` +2. Update values as needed + +Start the development server: + +```bash +npm run dev +# or +yarn dev +``` + # How to run? - Install [air](https://github.com/air-verse/air?tab=readme-ov-file#installation) - Run `air` command in the terminal @@ -22,4 +68,16 @@ make migrate-down 1 # NOT AVAILABLE ON PROD - Force migration version (use with caution) make migrate-force 1 -``` \ No newline at end of file +``` + +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. + +## License + +Distributed under the Apache 2.0 License. See [`LICENSE`](LICENSE) for more information. + +--- + +Maintained by the [PointBlank Club](https://github.com/pointblank-club)