README.md

Jobly

Because job searching should be more fun than your last job.

View Demo · Backend Repo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Key Features
   • Built With
2. Getting Started
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Jobly is a job search app that allows users to browse companies and jobs. Users can sign up, log in, and apply for jobs. Users can also edit their profile, follow companies, and view their application history. It was originally built in 2023 as a project for the Rithm School curriculum.

This repo contains the front-end code for the app. The back-end code can be found here.

The front-end is built in React and uses React Router for routing, React Bootstrap for styling, Axios for making API calls, and is hosted on Vercel. The back-end is written in Express and uses PostgreSQL for the database. It is hosted on Render and the database is hosted on ElephantSQL.

Taking the frontend and backend together, this project is a great way to learn more about:

• Building RESTful APIs and consuming them via Axios
• Separating concerns between frontend and backend
• React components and state management
• React Router
• Database design and modeling
• User authentication and authorization
• User sessions and cookies
• Encryption and password hashing

I'm excited to keep building on this project and add more features. Feel free to contribute!

You can log into the demo site with the following credentials:

• Username: guest
• Password: password

(back to top)

Key Features

(back to top)

Built With

This project was built in 2023 using the following technologies.

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

See requirements.txt for a full list of dependencies.

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

1. Clone the frontend and backend repos

   git clone https://github.com/seanoliver/react-jobly
   git clone https://github.com/seanoliver/jobly-backend

2. Create and seed the database

   createdb jobly
   cd jobly-backend
   psql jobly.sql

3. Install dependencies and run the backend server (Defaults to port 3001)

    cd jobly-backend
    npm install
    npm run start

4. In a new terminal, install dependencies and run the frontend server (defaults to port 3000)

    cd react-jobly
    npm install
    npm run start

5. Go to localhost:5000 to view the app

(back to top)

Roadmap

• Loading spinner for sign-up/sign-in views
• Guest credentials helper text
• Add a "forgot password" feature
• Add a "delete account" feature
• Bring in shadcn-ui components
• Standardize layout outs and spacing
• Reseed DB with more users, companies, jobs

(back to top)

Contributing

This is a great project for learning React Router, React Bootstrap, and consuming RESTful APIs. It's also a great project for learning about database design and modeling, user authentication and authorization, and user sessions and cookies. If you're interested in contributing, please feel free to open a pull request or fork the project and make it your own!

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)

License

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

(back to top)

Contact

Your Name - @SeanOliver - [email protected]

Project Link (Frontend): https://github.com/seanoliver/react-jobly

Project Link (Backend): https://github.com/seanoliver/jobly-backend

Live Demo: https://react-jobly.seanoliver.dev/

(back to top)

Acknowledgments

This was a project I completed as part of the Rithm School curriculum. I would like to thank the entire Rithm team for their great curriculum and support.

• Rithm School
• Best-README-Template
• Img Shields

(back to top)