KEEPUP

Table of Contents

• Description
• Links
• Technologies
• Screenshots
• Installation Instructions
• User Instructions
• License
• Contributors
• Contribution Instructions
• Acknowledgements
• Questions

Description

KeepUP is a full stack application that provides teams with a platform that makes communication easy! Chat with others, manage your projects, create notes, and more with KeepUP.

Links

URL to deployed application URL to GitHub repository

Technologies

Screenshots

Installation Instructions

1. Since KeepUP is primarily a NodeJS application, you must have NodeJS downloaded. Please download here if you have not done so previously.

2. To create and seed the database, you must have MySQL installed. Please download here if you have not done so previously. To create and seed the company_db database, please follow these instructions...

---

1. Log into MySQL into your command-line while be located in Employee-Tracker's repository.

mysql -u root -p

2. Once logged in, enter the following commands...

SOURCE main/db/schema.sql;

3. Exit the MySQL CLI by entering the following command...

quit

---

3. Create a .env file and input the following information

DB_NAME=user_db
DB_USER={ENTER MYSQL USER HERE}
DB_PASSWORD={ENTER MYSQL PASSWORD HERE}

4. Install all necessary packages by typing in the following command into your command-line...

npm i

5. To seed the database with dummy data, please enter the following command in your command-line...

npm run seed

6. You are then able to run your server by entering the following command into your command-line...

npm start

OR

node server.js

User Instructions

Feature	Instructions
Personal Notes	1. To add a note, click the pencil/paper in the top left corner of the notes section 2. To delete a note, click the trashcan in the top left corner of the note 3. To access the note content, click the space between the note title and trashcan 4. To edit the note, click the text you wish to edit and start typing
Creating a Project	1. To create a project, click 'Starting a new project?' 2. You must then add yourself to that project by clicking 'Add members to project' 3. Click your project in the Your Workspaces section
Trello Board	1. To add a list item, click '+ add new list' 2. To add a task item to a list, click '+ Add task' 3. To edit task or list text, click the text you would like to edit and start typing 4. To delete a list, click the trash can in the top left corner of that list NOTE: If you would like to delete a task item, you must put it into a list item that you then delete 5. You may toggle on/off the text editing by clicking the edit text toggle 6. You must click the moveable task/moveable list toggle. This feature gives the user a better user experience.
Chat	1. To send a message, simply type your message into the text box and click send 2. To send your geolocation, click the Google Maps Icon next to the send button
Update Profile	1. To update your profile, click your profile icon and click 'Edit Profile'
Logout	1. To log out, click your profile icon in the top right corner of the page and click logout

License

This project is licensed under the terms of MIT.

Contributors

Contribution Instructions

Before contributing to KeepUP, please read this code of conduct¹.
Here's how you can contribute...

1. Add issue or recommendation for improvement to Issues tab on Github.
2. Submit pull request for review.

Acknowledgements

Toggle on Project page was created by Sergey Zakharov; Animated checkmark on /project page was created by Gary;

Questions?

If you have any questions, please contact us via:

Name	Github	Email
Michael Klein	@inklein1997	michaelklein1997@gmail.com
Romeo Dixon	@romeodixonll	Romeodixonll@yahoo.com

Footnotes

1. Code of Conduct provided by Contributor Covenant ↩