The_Museum

Description

• A CLI app of a musuem Domain having three models namely:
  • Museums
  • Artists
  • Artworks
• Users should be able to navigate through this domain through a series of prompts and any changes made, updated in a database
• MVPs:
  • User should be able to see a list of museums and select their museum of choice
  • User should see showcased art pieces, and details of the artworks in the selected musuem
  • User should be able to request approval if they require to add artwork to the selected museums

How To Use

Setup Requirements

• A computer or laptop
• Internet access
• Visual Studio Code

Using the App

• In your local terminal:
  • Clone the repository by running:

  [email protected]:Ron-Maina/The_Museum.git
  

  • Navigate into the project folder:

  cd The_Museum
  

  • Open the project files by running

  code .
  

  To open them on visual studio
  • Install dependencies and enter virtual environment:

  pipenv install 
  pipenv shell
  

  • Switch directories to the app folder by running:

  cd app
  

  • Run the command below to execute the CLI application

  python cli.py open
  

Author

• Ron Maina, Pius Mwangi, Macray Korir, Cathy Maseki

License

MIT License

Copyright (c) [2023] [Ron Maina]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.