An overview | Get started | Command Line 101 | Contributors | Special thanks | License
Finding your next great read can be overwhelming with the huge selection of books out there. ChapterOne makes it easy to search through millions of books and filter by your preferences. No more endless scrolling and guessing - just tell ChapterOne what you're looking for to get tailored recommendations.
Key features:
✨ Discover books you may not have found on your own but will love
✨ Simple and intuitive interface allows you to fine-tune and customize your search
✨ Print out your customized reading list with just one click for easy reference
✨ Hassle-free way to find your next great read among millions of options
Tech stack:
1. Clone the repository
To get started, you'll need to clone the project's repository to your local machine. Open a terminal/command prompt and navigate to the directory where you want to store the project. Then, run the following command to clone the repository:
git clone https://github.com/milliedavidson/group5-project-codefirstgirlsaloud.gitThis will create a local copy of the project's files and code on your machine.
2. Install Dependencies
Make sure you have the required packages installed. Run the following command to install the required packages listed in your requirements.txt file:
pip install -r requirements.txt3. Run the Flask App
main.py is the main entry point of the Flask application. You can run the app by executing the following command in the terminal/command prompt within your project directory:
python main.pyThis should start your Flask app and make it accessible at the local address http://127.0.0.1:5001.
4. Access the Website 🤓
Open a web browser and navigate to the URL http://127.0.0.1:5001. You should see your Flask application's home page, ChapterOne.
⚠️ ⚠️ ⚠️ ⚠️
Flask provides a local server that is intended for testing and development purposes only. Read about security considerations here.
1. Open terminal
Open the terminal (MacOS & Linux) or command prompt (Windows) on your computer. This is the command-line interface where you can type commands.
2. Your current location
When you open the terminal, you're typically in your user's "home" directory. You can verify your current location by typing the following command and pressing Enter:
pwd3. Changing directory
To navigate to a specific directory, use the cd command followed by the path to the directory you want to navigate to. For example, to navigate to the "Programming" directory:
cd /path/to/Documents/ProgrammingYou can also cd into a directory one by one. For example:
cd Documentscd Programming4. Listing Contents
Once you've navigated to a directory, you can list its contents using the ls command:
lsThis will display the files and directories within the current directory.
5. Navigating Up
To navigate back to the parent directory (the directory containing your current directory), use:
cd ..6. Navigating Home
To return to your user's home directory, simply use cd without any arguments:
cd💡 Read more about the terminal here.
Olivia Boddy | Millie Davidson | Jesse Musenge | Ella Newell | Lucy Tesco | Jessica Wan
An enormous thank you to Code First Girls and ClearBank for providing us with the invaluable resources to develop our skills from print("Hello, World!") to a fully functioning web application!
We are incredibly grateful for this generous opportunity
This project is licensed under the MIT License.
Copyright 2023 ChapterOne
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.