The Sheriff of Nottingham is the main antagonist in the legend of Robin Hood. He is generally depicted as an unjust tyrant who mistreats the local people of Nottinghamshire, subjecting them to unaffordable taxes… (Wikipedia)

To use the deployed version on the web, visit → https://nottingham.onrender.com/

<aside> ⚠️ Please note that this project is on the Render free tier, so your first request (login or register) may take a longer time as the backend performs a cold start.

</aside>

*To run locally, ***please download the latest build from GitHub → ‣

✨ Features

• 👥 User accounts
  • Register and login, rest assured your data is protected with JWT token authentication.
• 🏦 Maintain a balance
  • As a user, you have access to a balance and can add money to your brokerage account anytime on the ‘balance’ page!
• 📈 View your positions
  • The homepage shows you your balance & all of your positions in a lovely tile layout, complete with charts of overall stock performance.
  • Stocks are red if they have performed badly over a 3 month period, and green if they have performed well or broke even.
• 🛍️ Buy & sell stock units
  • Once you’ve added balance to your brokerage account, you can buy & sell stock units on the ‘trade’ page!
• 🔎 Get stock information
  • Search for a stock ticker and get a summary of its performance along with some neat tidbits, powered by Yahoo Finance.

🌎 Live On The Web!

Nottingham is now deployed and ready for public use at https://nottingham.onrender.com/ (all deployed on Render!)

📦 Local Installation + Setup

1. Navigate to the backend folder- first, we set up the backend.

2. Activate the Python virtual environment by running the following command: source nottingham/bin/activate

3. Set up the PostgreSQL database

   1. Open the Postgres app (or psql if you prefer to start on the command line) and enter a database prompt.

   2. Run the following command, which will create a PostgreSQL database named nottingham on the current server.

      CREATE DATABASE nottingham
      

   3. Ensure that this server is running on port 5432. (Or, use a different port in subsequent steps referencing the db’s port).

   4. In the backend directory, run flask db upgrade to ensure that you have applied all the migrations to your local database.

4. Create a .env file in the backend folder, and fill out the environment variables accordingly. The database URL should be the URI of your database, the JWT secret key can be anything you want it to be, and the frontend URL is in place to circumvent CORS errors.

   DATABASE_URL=postgresql://postgres:postgres@localhost:5432/nottingham
   JWT_SECRET_KEY=priyanka
   FRONTEND_URL=http://localhost:3000
   

5. Run the backend, using python3 run.py

6. Next, go back up to the root level of the directory and open the frontend folder.