Flask React Project

EmployMe

Link To EmployMe Live

EmployMe is a custom website designed to allow job seekers to create detailed resumes with a clean layout. Company owners can create job listings and company pages. EmployMe helps job seekers and company owners find the best possible matches.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
3. Examples
4. Features In Development
5. Contributing
6. Contact

About The Project

'EmployMe was designed to help job seekers and company owners find the best possible matches.'

(back to top)

Built With

(back to top)

Running the server locally

1. Clone the main branch of this repository.

2. Install dependencies

pipenv install -r requirements.txt
cd react-app
npm i

3. Create a .env file based on the .env.example file with proper settings for your development environment.

In order to use the file upload services you will have to create a S3 Bucket on AWS (Amazon Web Services)

SECRET_KEY=ARandomString
DATABASE_URL=sqlite:///dev.db
SCHEMA=flask_schema
S3_BUCKET=BucketName
S3_KEY=BucketKey
S3_SECRET=BucketSecretKey

4. Create, migrate, and seed the database.

  "pipenv run flask db init && pipenv run flask db migrate && pipenv run flask db upgrade && pipenv run flask seed all"
  
  If you are in the pipenv shell
  "flask db init && flask db migrate && flask db upgrade && flask seed all"

5. Run the server locally

Open two terminals one in / and one in /react-app

/: "pipenv run flask run"  OR "flask run" (if you are in the shell)
/react-app: "npm start"

(back to top)

To run the React App in development, checkout the README inside the react-app directory.

Examples of site functionality

Create your account with secure hashed password protection.

The home page displays recent posts from EmployMe users. You can scroll to the bottom of the page to load more posts.

You can set up your profile and create posts to create your best resume.

You can create job listings so job seekers can contact you.

(back to top)

Features in development

• Albums for images
• Recommendations
• Company Profile Page
• Feedback/Reviews
• Messages/Inbox

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

(back to top)

Contact

Nathan Heinz - [email protected]

Project Link: https://github.com/NRH-AA/EmployMe

(back to top)