Skip to content

Latest commit

 

History

History
97 lines (66 loc) · 3.31 KB

README.md

File metadata and controls

97 lines (66 loc) · 3.31 KB
Raw

Ratemyresume

Real people rate your resume

A website where you can upload your resume and get a rating from 0-10 from other users. Built with Django and AWS.

Features

  • User authentication
  • File uploads
  • Comment sections
  • Create or join groups of users
  • Invite users to your group and request to join a group
  • Granular privacy controls for resumes
  • Search functionality
  • Responsive
  • AJAX

Install

  1. Install the required prequisites.

    Required prequisite downloads:

    Recommended downloads:

    • Visual Studio Code - code editor
      • Recommended Extensions:
        • CSS Peek by Pranay Prakash
        • Django Support by Al Mahdi
        • django-intellisense by shamanu4
        • GitLens - Git supercharged by GitKraken
        • Pylance by Microsoft
        • Python by Microsoft
        • Python Debugger by Microsoft
    • GitHub Desktop - GUI for Git
    • pgAdmin 4 - See database contents and execute SQL for debugging

  2. Clone the repository to your device

    git clone https://github.com/zgstumpf/ratemyresume.git

  3. Navigate into the new cloned directory

    cd ratemyresume

  4. Create the .env file

    In the root project directory, create a file named .env. Copy the template from docs > env.md and paste into the .env file. You need to fill in the values for each key. Ask a team member for help or retrieve the values from AWS.

  5. Open Docker Desktop

  6. Build the Docker container

    docker-compose up

Run locally for development

  1. Make sure the AWS services are running. The database may have been temporarily stopped during non-development periods.

  2. cd into the directory containing manage.py

  3. Open Docker Desktop

  4. Run docker-compose up

  5. In a browser, search http://localhost:8000/. (The terminal output may give a different URL - ignore it.)

Most errors should appear in the same terminal you ran docker-compose up in, but sometimes errors are only viewable in Docker Desktop (Containers -> ratemyresume). If the app fails to start, check there.

Any changes you make to most files will automatically trigger page reloads. If you edit files in a static directory, you need to manually refresh the page to see the changes. If that doesn't work, hard reload the page.

If you edit models.py to edit the database structure, you need to run some commands before the changes take place. To enter the commands in the same command line that is running the server, you need to first quit the server with control + c.

python manage.py makemigrations
python manage.py migrate

If you make any changes in the .env file, restart the server (quit the server and run docker-compose up) for your changes to take place.

When you are done developing, quit the Docker container with control + c, or stop it in Docker Desktop.

Install Python package

  1. Manually add the package name and version in environment.yaml
  2.  docker-compose build