glitchwizard / StarMaxApp

StarMax app, like CarMax, but for GoEngineer's space fleet.

StarMax

A used starship dealership website

Description

This is a website for a used starship dealership. It allows users to view the current inventory, add new ships to the inventory, and edit or delete existing ships. It also allows users to view the details of each ship, including the ship's name, manufacturer, model, price, and description.

Required Technologies

• .NET SDK 7.0.
• Docker Desktop
• make
  • Some ways to get make
• Node.js
• npm
• Entity Framework Core CLI

Suggested Technologies

• Visual Studio 2022 - makes it easier to run after cloning
• SQL Server Management Studio (optional)

Setup/Installation Requirements with all tech, suggested and required

1. Clone this repository to your desktop
2. Navigate to StarMaxApp folder after
3. run make init
4. Visual Studio (NOT VS Code!) should open at the end of the the init sequence
5. Click the dropdown on the Start button in Visual Studio and select Configure Startup Projects

(https://imgur.com/a/rZBZP1F)

6. Select Multiple startup projects: and set the action to Start for both.

(https://imgur.com/a/UbqzUYM)

7. Click Apply, then OK, closing the dialog box.

Setup/Installation Requirements the manual way

1. Clone this repository to your desktop
2. Navigate to StarMaxApp folder
3. Run docker-compose up -d db to start the MSSQL DB
4. Navigate to StarMax_BackEnd and run dotnet restore
5. Navigate to StarMax_FrontEnd and run npm install
6. Navigate back to StarMax_BackEnd and run dotnet dotnet-ef database update
   • if you have Entity Framework Core CLI installed globally, you can run dotnet ef database update
7. If you have Visual Studio, follow steps 5, 6 and 7 in the section above to set the Startup config

Running the app

With Makefile and Visual Studio IDE

1. Navigate to the project root folder StarMaxApp and open StarMaxApp.sln
2. Press the Start button at the top of Visual Studio and happy starshipping!

The Manual Way

1. Navigate to the project root folder StarMaxApp
2. Verify the MSSQL docker container is up and running, if not run docker-compose up -d db
3. You'll need two terminals open
4. In the first terminal, navigate to StarMax_BackEnd and run dotnet run. This starts the API.
   • Note: You'll need internet because the back end makes a call to swapi.dev to get the starship list and seed the database.
5. In the second terminal, navigate to StarMax_FrontEnd and run npm start. This will start the front end.

Known Bugs

• No known bugs at this time
• Please contact me if you find any bugs or have suggestions
• Contact me at: [e-mail]

Technologies Used

• C#
• ASP.NET Core MVC
• Entity Framework Core
• MSSQL
• HTML
• CSS
• Bootstrap
• JavaScript
• React

License

• This project is licensed under the MIT License
• © 2023 Charley McGowan

Contact Information

Charley McGowan [e-mail]