Keeper

Table of Contents

• Description
• Screenshot
• Dependencies
• Installation
• Usage
• Supported Versions
• Contributing
• Bugs and Issues
• License

Description

A note taking application that is built using NodeJS and Express and uses Bootstrap 4 as its CSS framework.

Screenshots

Keeper's Main Index Page Keeper - Empty Database View Keeper - Create Note View Keeper - Saved Notes View

Dependencies

Project Dependencies

• "bootstrap": ^4.6.0
• "del": ^6.0.0
• "express": ^4.17.1
• "gulp": ^4.0.2
• "gulp-autoprefixer": ^7.0.1
• "gulp-live-server": 0.0.31
• "gulp-minify": ^3.1.0
• "gulp-rename": ^2.0.0
• "gulp-sass": ^4.1.0
• "gulp-sourcemaps": ^3.0.0
• "jquery": ^3.5.1
• "popper.js": ^1.16.1

Installation

Requirements

You will need the Node.js Package Manager (npm) for use with this project.

• Node.js and npm

Install

Download the zip or clone this project.

git clone https://github.com/davidsaulrodriguez/keeper.git
cd keeper/

Now install the required dependencies with npm.

npm install

Usage

Development

All source code development happens in the src folder. You can make your changes in the source folder and then compile them by running

npm run build

After running npm run build it will output a public/ folder with all of your source files compiled.You can then start the live server and in your browser of choice go to http://localhost:3000 after running:

npm run start

Deployment

See the development steps above. They are the exact steps required to deploy the application into production.

If you are deploying to Heroku, there are already scripts in the package.json file to build the app and deploy it automatically on the platform.

Supported Versions

Below is a list of the currently supported versions of this software.

Release	Status	Initial Release	Active LTS Start	Maintenance LTS Start	End of Life
v1	✔️	2021.01.23	TBD	TBD	2021.07.23

You can view the Status Key Map below.

Contributing

Contributions are more than welcome! If you improve on this project skeleton, please feel free to share it by submitting a Pull Request.

Before contributing, be sure to check out the CONTRIBUTING file.

Bugs and Issues

Found a bug? Having an issue with this app? Open a new issue here.

License

This project and all of its source code is released and permissively licensed under the BSD 2 Clause license.