local-business-project-3

Local Business Project 3 Website

This is a page that allows user to sign up to, login and request jobs. It is made for people to ask around for jobs that can be done by local businesses. They will be able to edit and say complete to jobs they have requested and they can search for jobs if they are a local business looking for work.

User Experience (UX)

Features

Technologies Used

Languages Used

Frameworks, Libraries & Programs Used

  1. Materialize 1.0.0:
    • Materialize was used to assist with the responsiveness and styling of the website.
  2. MongoDB:
    • MongoDB was used as the database for the Interactive code work.
  3. Font Awesome:
    • Font Awesome was used on all pages throughout the website to add icons for aesthetic and UX purposes.
  4. jQuery:
    • jQuery was used alongside Materialize for things like the side nav bar and request jobs form in JavaScript.
  5. Git
    • Git was used for version control by utilizing the Gitpod terminal to commit to Git and Push to GitHub.
  6. GitHub:
    • GitHub is used to store the projects code after being pushed from Git.

Testing

Testing User Stories from User Experience (UX) Section

Further Testing

Known Bugs

Deployment

GitHub Pages

The project was deployed to GitHub Pages using the following steps…

  1. Log in to GitHub and locate the GitHub Repository
  2. At the top of the Repository (not top of page), locate the “Settings” Button on the menu.
    • Alternatively Click Here for a GIF demonstrating the process starting from Step 2.
  3. Scroll down the Settings page until you locate the “GitHub Pages” Section.
  4. Under “Source”, click the dropdown called “None” and select “Master Branch”.
  5. The page will automatically refresh.
  6. Scroll back down through the page to locate the now published site link in the “GitHub Pages” section.

Forking the GitHub Repository

By forking the GitHub Repository we make a copy of the original repository on our GitHub account to view and/or make changes without affecting the original repository by using the following steps…

  1. Log in to GitHub and locate the GitHub Repository
  2. At the top of the Repository (not top of page) just above the “Settings” Button on the menu, locate the “Fork” Button.
  3. You should now have a copy of the original repository in your GitHub account.

Making a Local Clone

  1. Log in to GitHub and locate the GitHub Repository
  2. Under the repository name, click “Clone or download”.
  3. To clone the repository using HTTPS, under “Clone with HTTPS”, copy the link.
  4. Open Git Bash
  5. Change the current working directory to the location where you want the cloned directory to be made.
  6. Type git clone, and then paste the URL you copied in Step 3.
$ git clone https://github.com/JoeLouisDsantos/local-business-project-3.git
  1. Press Enter. Your local clone will be created.

Click Here to retrieve pictures for some of the buttons and more detailed explanations of the above process.

Heroku

  1. Create a requirements.txt file using the terminal command pip freeze > requirements.txt.
  2. Create a Procfile using the terminal command echo web: python app.py > Procfile.
  3. git add, git commit and git push these to the Github pages.
  4. Create a new app on Heroku by clicking the New button on the dashboard. Give it a name and select the region.
  5. On the new app click Deploy > Deployment method and then select github pages.
  6. Confirm the linking of the Heroku app and the Github repository.
  7. In the Heroku app click settings, then go to reveal config values.
  8. Set the following config values: (“IP”, “0.0.0.0”) (“PORT”, “5000”) (“SECRET_KEY”, “your_secret_key_here”) (“MONGO_URI”, “mongodb+srv://:@-4g3i1.mongodb.net/?retryWrites=true&w=majority") ("MONGO_DBNAME", "")
  9. Go onto deploy, scroll down to manual deployment then click deploy branch.
  10. Now the app has been successfully deployed.

Credits

Code

Content

Acknowledgements