diff --git a/docs/README.md b/docs/README.md index 9725b66..87c1849 100644 --- a/docs/README.md +++ b/docs/README.md @@ -28,7 +28,8 @@ Vidur is an open-source, modern recruiting software designed to make hiring fast ![banner](banner.png) -This design ensures transparency, efficiency, and ease of use. With Vidur v1.0, you can - +This design ensures transparency, efficiency, and ease of use. With Vidur v1.0, you can - + 1. Create and manage your own career sites to showcase job openings and attract candidates. 2. Add and build plugins to extend Vidur’s functionality and connect with other tools you use. 3. Allow candidates to apply for jobs with just one click, simplifying the application process. @@ -36,6 +37,7 @@ This design ensures transparency, efficiency, and ease of use. With Vidur v1.0, 5. Add as many team members as needed without restrictions, so everyone can collaborate effectively. ## How Vidur Works + - **Free and Open-Source:** Vidur is free to use with the option to self-host or opt for managed services. - **Customizable Plugins:** Create unlimited plugins and extensions tailored to your hiring needs. - **Unlimited Team Members:** Invite your entire team with no additional costs. @@ -44,23 +46,30 @@ This design ensures transparency, efficiency, and ease of use. With Vidur v1.0, You can also schedule a quick call with the team [here](https://calendly.com/0xdevshah). ## Getting Started + To get up and running with Vidur, follow these steps: ### Local Setup + 1. **Ensure PostgreSQL is Installed** Make sure you have a PostgreSQL instance running. If you need help setting it up, refer to the [PostgreSQL documentation](https://www.postgresql.org/docs/). 2. **Clone the Repository** + ```bash git clone https://github.com/your-repo/vidur.git cd vidur ``` + 3. **Install Dependencies** Install Yarn if you haven't already: + ```bash npm i -g yarn # Install all project dependencies yarn ``` + 4. **Configure Environment Variables** Create a `.env` file from the example template: + ```bash cp .env.example .env @@ -68,28 +77,35 @@ cp .env.example .env ``` 5. **Set Up the Database** Apply the database schema: + ```bash yarn migration:apply ``` + 6. **Start the Development Server** Run the development server: + ```bash yarn dev ``` ### Using Docker + If you prefer using Docker, you can quickly set up Vidur with Docker Compose: -```bash + +```bash docker compose up ``` + This command starts both the `db` and `app` services using the `dev` profile, running PostgreSQL as `database` and the app as `vidur_app`. You can also pull the latest Docker image from [here](https://hub.docker.com/r/profilecity/vidur/tags). - ## Contributing + We welcome contributions from the community! Check out our [contribution guide](./CONTRIBUTING.md) to get involved and help us make Vidur even better. ## Contributors + Vidur wouldn’t be possible without the support and contributions from our amazing community. A special thank you to all our contributors who have helped make Vidur better. You can find a list of our contributors - @@ -102,18 +118,23 @@ Vidur wouldn’t be possible without the support and contributions from our amaz ## Roadmap + We believe in transparency and collaboration, which is why we've open-sourced our [Roadmap](https://github.com/orgs/profilecity/projects/5). You can view our planned features, ongoing projects, and future updates on our Roadmap. We welcome feedback and suggestions from the community to help shape the future of Vidur. ## Release Notes + Stay up-to-date with the latest improvements, bug fixes, and new features by checking our [Release Notes](https://github.com/profilecity/vidur/releases). Each release note provides detailed information about the changes and updates made in every version of Vidur. ## Staying ahead + Star Vidur on GitHub and set the repo on a watch to be instantly notified of new releases. ![Star Image](asset/star-repo.gif) ## Security disclosure + To protect your privacy, please avoid posting security issues on GitHub. Instead, send your questions to teams@profilecity.xyz and we will provide you with a more detailed answer. ## Contact -For any questions or support inquiries, please contact us at teams@profilecity.xyz, raise a query on the Discord server or create an issue on our GitHub repository. \ No newline at end of file + +For any questions or support inquiries, please contact us at teams@profilecity.xyz, raise a query on the Discord server or create an issue on our GitHub repository.