Star Gazer

2020

DESCRIPTION

Node based app that allows users to log in and view information about different astrological formations.

Deployed Link

INSTALLATION INSTRUCTIONS

- [Local Setup]

1. Setup the database by inputting your Mysql Workbench user & password in the config.js file, located in the config file, line 3 & 4.

2. Either build the database using Workbench or the CLI with the provided schema.sql in the db folder.

3. Then run the following two commands to migrate the database "npx sequelize-cli db:migrate",then - "npx sequelize-cli db:seed:all".

4. Install the required modules by typing "npm install" or "npm i" in the containing folder using your code editor terminal.

5. Run the app by typing "node app.js" or "node app."

6. If successful, the user will see "connected on localhost:8080," and will be able to click on the link to see the app displayed in their default browser.

7. The user can then either sign up, or log in to see the main content. The user can also log out after they are done.

   • [Deployed Setup]

8. Click on the following Heroku link to see the deployed version. https://limitless-atoll-63723.herokuapp.com/

RESOURCES

• Star Registry
• Constellation-Guide

BUILT WITH

• HTML
• CSS
• Javascript
• JQuery
• Bootstrap
• Font Awesome
• Node
• NPM
• MySql Workbench
• Heroku
• JawsDB
• Travis-ci

NODE MODULES USED

• MySql
• Express
• Eslint-config-prettier
• Eslint-plugin-prettier
• Express-handlebars
• Prettier
• Mysql2
• Sequelize
• Eslint
• Nodemon
• Bcryptjs
• Body-parser
• Constellations
• Express-sessions
• Jquery
• Passport
• Passport-local

AUTHOR

• Elizabeth Garcia-Quilinquin * Github
• Laurie Schroeder * Github
• Jared Bucko * Github
• James Nelson * Github

MIT License

Copyright (c) [2020][james nelson, elizabeth garcia-quilinquin, jared bucko, laurie schroeder]

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.