Skip to content

TBertazoli/Lab_notebook

Repository files navigation

Work Bench

Description

This application is a virtual lab bench where the user can create new notebooks for different subjects, add new lab entries to the notebooks, delete lab entries, and comment on other users lab entries.

Badges

Table of Contents

Visuals
Installation
Usage
Support
Roadmap
Acknowledgements
License
Status

Visuals

Installation

In order for this application to work, the user will need to install the Express, Express Handlebars, Express session, MySQL2, Sequelize, and connect-session-sequelize packages. The user will also need to install dotenv and bcrypt to hide sensitve information like the database password.

Usage

First, the user will open the terminal and navigate to the application.
Then, the user will run mysql2 using either the command:

% mysql -u root

or

% mysql -u root -p

if there is no set password or a set password, respectively. This will create the database.
Once it is confirmed that the database is created and in use, the user can exit mysql using the command:

% quit

The user can then interact with the application by typing

npm start

into the terminal and navigating to the browser and typing the following into the search bar:

localhost:3001

Or, the user can enter the following link into the search bar:

https://obscure-lake-69191.herokuapp.com

There, the user can sign-in if they have already created an account or can click the link to sign-up if they have not. Alt text Alt text

After signing-in or signing-up, the user will be taken to their dashboard. An existing user will see their previous lab notebooks with the options to view the experiments contained within, edit the notebook, or create a new notebook. Alt text Alt text

If they are a new user, they will see an empty dashboard with the option to create their first notebook. Alt text

The user also has the option to view and edit the experiments contained within each notbook, as well as view and post comments and attachments to an experiment. Alt text Alt text Alt text Alt text

Support

Roadmap

Future iterations of this application will include the ability to add a manager and will allow only users with proper authorization to access lab entries.

Acknowledgements

This project was made by Tatiana Bertazoli, Emily Hill, and Wenbo Li.

The badges for this README were acquired here and here.

License

Project Status