FrontEnd Routes - ChrisPHong/Sea GitHub Wiki
Splash Page
- A user that is not logged in will see the splash page.
/- Displays a sign-up/register button that will take them to the sign-up form to enter their first name, last name, email, hashed password, and balance.
- Displays a log-in button that will take them to the log-in form to enter their credentials.
- Displays the purpose and functionality of the web application.
Log-in Page
- A user that is not logged in will see the log-in page.
/login- Displays a form where credentials can be entered.
- Displays a log-in button that will check the entered credentials.
- Displays a sign-up button that will take users to the sign-up page to create an account if they do not have an account.
- Displays error if log-in attempt fails.
Sign-up Page
- A user that is not logged in will see the sign-in page.
/login- Displays a form where credentials can be entered.
- Displays a sign-up button that will enter user's information to create an account.
- Displays a log-in button that will take users to the log-in page.
- Displays error or errors if sign-up attempt fails.
Watchlists
-
Get all of the Watchlists
/watchlists- Displays all the watchlists with their names on the dashboard.
- Option to click on a watchlist name block and show the stocks associated with that specific watchlist.
- Option to click on a watchlist name block and hide the contents of the stocks associated with the watchlist.
-
Create a new Watchlist
/watchlists- Displays a button on dashboard to add a new watchlist to dashboard/portfolio.
-
Update a Watchlist
/watchlists/:id- Displays an edit button with watchlist to take user to edit page to add or remove stocks from watchlist.
-
Delete a watchlist
/watchlists/:id- Displays a button near watchlist for user to remove watchlist from his or her dashboard/portfolio.
-
Gets a specific watchlist
/watchlists/:id- Displays the name of a specific watchlist with all of the associated stocks.
- Displays the name of each stock as well as the price and ticker symbol.
- Displays an edit button associated with watchlist to add or remove stocks from watchlist.
- Displays a delete button associated with watchlist to delete watchlist.
Stocks
- Gets a specific stock
/stocks/:id- Displays the stock price.
- Displays the ticker symbol.
Search
- Get certain stocks
/stocks/search- Displays a search bar where users can enter name of stock.
- Displays stocks that best match the search input value.
- Displays nothing when there are no matches for search input value.
Portfolio
- Logged in Users will get the user's portfolio and their watchlists on the side and at the bottom of the portfolio, you'll be able to see the news articles.
/- Displays the user's current balance in their portfolio.
- Displays currently owned stocks.
- Displays the user's watchlists in the dashboard on the side of the portfolio.
- Displays news articles below the portfolio that shows the article title and picture(?).
Transactions
- Get all of the user's transactions
/transactions- Displays the history of transactions the user has made.
- Option to click on a transaction name block and show the details associated with that specific transaction.
- Option to click on a transaction name block and hide the details associated with transaction.