README.md

Tip

🎉 Now open-source for everyone!

exhibit

📇 Work in progress job board with apply feature.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Exhibit is an open-source board for jobs and applications. You can publish jobs and users can send applications to the admin with all information and also uploadable CVs. It also includes notifications about the application status,

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap the project.

• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Before you start you need the following prerequisites.

• Install pnpm (if you haven't already).

  corepack enable pnpm

• Download the backend from Pocketbase. And move the executable to the folder backend.

Installation

Below you will be instructet how to set up the project.

1. Clone the repo

   git clone https://github.com/jqshuv/exhibit.git

2. Install NPM packages

   pnpm install

3. Start the backend and initialize it in the backend. Setup pocketbase and use pb_schema.json in the admin panel to load the schema.

4. Start the app

   pnpm dev

(back to top)

Usage

Head over to https://localhost:3000 and try the application

(back to top)

Roadmap

Noting planned but probably soon. Feel free to contribute.

See the open issues for a full list of proposed features (and known issues).

(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

Top contributors:

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Your Name - @jqshuv - [email protected]

Project Link: https://github.com/jqshuv/exhibit

(back to top)