Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devanshi-bavaria/job-seek
https://github.com/devanshi-bavaria/job-seek
mongodb nextjs tailwindcss typescript
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/devanshi-bavaria/job-seek
- Owner: Devanshi-Bavaria
- License: mit
- Created: 2024-08-26T17:42:10.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-26T17:50:26.000Z (3 months ago)
- Last Synced: 2024-11-02T21:02:23.108Z (13 days ago)
- Topics: mongodb, nextjs, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://job-portal-six.vercel.app/
- Size: 694 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Job Portal Application
Table of Contents
## About The Project
**Job Portal Application** is a web application that have 3 main roles inside it, such as admin, organization, and also jobseeker. A jobseeker role can find and apply job to a certain opened job by an organization like usual, uploading their CV, edit their profile, etc. An organization role has access to post a job, hire and reject applicant, etc. An admin role will mainly keep track of organization that are registered to the application, then decide whether to accept or reject the organization based on the information provided.
### Built With
Main technology used to built this application are listed below:
* [Typescript](https://www.typescriptlang.org/)
* [Next.js](https://nextjs.org/)
* [Tailwind CSS](https://tailwindcss.com/)
* [MongoDB](https://mongodb.com/cloud/atlas/)
## Getting Started
To get started with this project locally, follow below steps:
### Prerequisites
Make sure you have package manager (either npm or yarn)
>**FYI**: This project uses **yarn** as package manager, but you're free to use **npm** too.
* Install Yarn (Only for user who want to use **yarn**)
```
npm i -g yarn
```
### Installation
Below steps will guide you through the local installation process of this application
1. Get your **Google Client ID**, **Google Client Secret**, and also **GMail Refresh Token** from [here](https://console.developers.google.com/)
2. Get your MongoDB cloud connection at [here](https://mongodb.com/cloud/atlas)
3. Clone the repo
```
git clone https://github.com/stanleyclaudius/job-portal.git
```
4. Install project dependency
Make sure that your terminal pointing at the root directory of this project (job-portal folder).
```
yarn install && cd client && yarn install
```
5. Complete the .env.local variable
Rename .env.local.example file at ```job-portal``` directory become ```.env.local```, then fill the value for every key. Below is the guideline for filling the .env value:
| Key | What To Fill | Example Value |
| :---: | :---: | :---: |
| CLIENT_URL | Your client side URL | http://localhost:3000 |
| MONGO_URL | Your MongoDB URL | mongodb://user:user1234@main-shardxxxx |
| ACCESS_TOKEN_SECRET | Random complex string for JWT | DUhxdx183)_--aACN#2%
| REFRESH_TOKEN_SECRET | Random complex string for JWT | 17hdjcD7ud(-*&732~
| ACTIVATION_TOKEN_SECRET | Random complex string for JWT | kc81i^&%`-Did##1Z
| GOOGLE_CLIENT_ID | Your google client ID | 3392348929324-tarur228dxxx |
| GOOGLE_CLIENT_SECRET | Your google client secret | GOCSPX-xxxxxxx |
| GMAIL_REFRESH_TOKEN | Your gmail refresh token | 1//028dhdjBMudu2829xxx |
| MAIL_SENDER_ADDRESS | Email that want to be used to send mail | [email protected] |
6. Lastly, run below command at your terminal to spin off the application
```
yarn dev
```
## Contributing
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
## Acknowledgments
Special thanks to:
* [Othneildrew](https://github.com/othneildrew/) for providing an amazing README template.
* [React Icons](https://react-icons.github.io/react-icons/) for providing icon to be used in this application.
* [Tailwind CSS](https://tailwindcss.com/) for providing CSS framework to be used in this application.
* [Vercel](https://vercel.com) for providing hosting service for this application.
[forks-shield]: https://img.shields.io/github/forks/stanleyclaudius/job-portal.svg?style=for-the-badge
[forks-url]: https://github.com/stanleyclaudius/job-portal/network/members
[stars-shield]: https://img.shields.io/github/stars/stanleyclaudius/job-portal.svg?style=for-the-badge
[stars-url]: https://github.com/stanleyclaudius/job-portal/stargazers
[issues-shield]: https://img.shields.io/github/issues/stanleyclaudius/job-portal.svg?style=for-the-badge
[issues-url]: https://github.com/stanleyclaudius/job-portal/issues
[license-shield]: https://img.shields.io/github/license/stanleyclaudius/job-portal.svg?style=for-the-badge
[license-url]: https://github.com/stanleyclaudius/job-portal/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/stanley-claudius-4560b21b7