Copyright (c) 2022 Haley Seymour
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.
To install this project:
- Start by forking this repository on Github.
- Clone this project to your machine by using the "git clone + URL" command.
- Open the project with your favorite text editor, like VS Code (in your terminal, first type "cd foldername" then "code .").
- Install Node.js from their website, if you have not already. Here are some additional instructions.
- Install MySQL from their website, if you have not already. Here are some additional instructions.
- Suggest installing Nodemon if you have not already.
- Suggest installing Insomnia if you have not already.
- This project includes a package.json file that specifies dependencies for this project, so be sure to run "npm install". This will install the packages specified in the next section.
General Technologies:
- Javascript
- Node.js
- Git
- Heroku
- Insomnia
NPM Packages
- nodemon
- express
- dotenv
- mysql2
- sequelize
The goal of this project is to assist an e-commerce company in organzing it's retail database. This allows for ease of use to find products in the system, as well as find associated categories and tags. This project configures an API through Express.js and utilizes Sequelize to interact with a MySql database. By following the installation and usage instructions in this README, you can use this program too! Create a ".env" file with your environmental variables (database name, mySql username, and mySql password). Run the commands specified to develop the database and seed it with data (if desired). Start the server and perform Get/Post/Put/Delete routes to the API to see it in action. This program has full CRUD functionality (create, read, update and delete)! Through this project I learned how to use sequelize to interact with the database and create a fully functional API.
To view this project deployed, click here.
After following the instructions in installation:
- Open the database file in your terminal.
- Run command "mysql -uroot -p" and enter your password (note: keystrokes will not show).
- Run command "SOURCE schema.sql" to set up the database and tables.
- Optionally, run command "npm run resetdb" to replace steps 2 and 3 (enter password when prompted).
- OK to 'quit' MySql.
- Create a file called ".env" in the root folder of the program. In this folder include the following information:
DB_NAME=''
DB_USER=''
DB_PW='' - Open the "server.js" file in your integrated terminal.
- Run command "npm run seed" (or "node seeds/index.js") to seed the database if desired.
- Run command "npm run start" (or "node server.js"). Alternatively, if you have Nodemon installed, run "npm run watch" (or "nodemon server.js").
- Open insomnia and type in "localhost:3001/api/_" in the address bar. Replace underscore with 'products', 'categories', or 'tags'.
- Enter get, post, delete or put requests as you please.
- When finished, run CONTROL-C in terminal to end stop nodemon, and trash the session.
Please check out this [video](https://drive.google.com/file/d/1DmJywG85k4h2NRHRiwhJ4HRzHdPwSgnV/view) for a demonstration of how to use this program.
GIF of Category Routes
GIF of Product Routes
GIF of Tag Routes
GIF of Deployed Site
This project was completed by myself, Haley Seymour, with starter code provied from the University of Washington Web Development Bootcamp. If you would like to contribute, please do and let me know if you have any questions.