NoveList is a website designed for readers to keep track of the novels they have read, log start- and finish-dates, make notes on their reading, and connect with friends.
- Project Requirements and Features List
- Technologies Used
- Installing and Launching NoveList
- Appendix 1: Planning Documentation
- Appendix 2: Set Up Instructions
When a user first registers an account with NoveList they will be directed to a welcome page. Will go to the Search option in the NavBar and search for their first novel to begin their library.
Once a user has added one or more books to their library they can navigate to Novels to see a list of their added titles. From here they can click the novel's title to see a detail view of that book, including notes they have added and a list of friends who have also sheved the book.
To launch the KaBloom app, you will need to have access to command line tools, node package manager, JSON Server. If you do not have access to any of these tools, you can find instructions for installing them in the Appendix.
Clone this repo on you personal machine using the following command
git clone [email protected]:xine75/NoveList.git
Install the NPM dependencies for this project using the following commands
cd NoveList
npm install
From your terminal window, type
npm start
Now that the server is up and running, you can open an internet browser and access the application
http://localhost:8080/
You will need to have command line tools installed for your computer to use terminal commands.
Linux/ Windows users, please visit the Git page and follow the instructions for set up
Mac users follow the instructions below
Open your terminal and type
git --version
You will now need to configure your git account. In the terminal window, type:
git config -global user.name "Your Name"
git config -global user.email "Your Email"
If you do not have Node.js installed on your machine, visit the Node.js Download Page and follow the instructions. To ensure that it is installed correctly, in your terminal window, type
echo $PATH
Ensure that the result has the following in the $PATH
/usr/local/bin
or
/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin
-
Pull down this repo
-
Run the script that's in the SQL folder. This will create the NoveList database.
-
You will need to set up a Firebase account: do the follow steps in the firebase console:
- Go to Firebase and add a new project. You can name it whatever you want (Tabloid is a good name)
- Go to the Authentication tab, click "Set up sign in method", and enable the Username and Password option.
- Add at least two new users in firebase. Use email addresses that you find in the UserProfile table of your SQL Server database
- Once firebase creates a UID for these users, copy the UID from firebase and update the
FirebaseUserId
column for the same users in your SQL Server database. - Click the Gear icon in the sidebar to go to Project Settings. You'll need the information on this page for the next few steps
-
Go to the
appSettings.Local.json.example
file. Replace the value for FirebaseProjectId with your own -
Rename the
appSettings.Local.json.example
file to remove the.example
extension. This file should now just be calledappSettings.Local.json
-
Open your
client
directory in VsCode. Open the.env.local.example
file and replace__YOUR_API_KEY_HERE__
with your own firebase Web API Key -
Rename the
.env.local.example
file to remove the.example
extension. This file should now just be called.env.local
-
Install your dependencies by running
npm install
from the same directory as yourpackage.json
file
Now you can follow the installation instructions to get NoveList up and running on your machine.
This project was bootstrapped with Create React App.