Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/espinbrandon49/stark_bare_notes

Full Stack Notetaking App - Stark Bare Notes
https://github.com/espinbrandon49/stark_bare_notes

bootstrap express heroku javascript json nodejs

Last synced: 2 days ago
JSON representation

Full Stack Notetaking App - Stark Bare Notes

Awesome Lists containing this project

README

        

# Stark Bare Notes
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)

## Description
A note-taking application to write and save notes so that you can can organize your thoughts and keep track of tasks you need to complete.

### Tools
- Frontend: HTML, Bootstrap, CSS, JavaScript
- Backend: NodeJS, Express.js
- Database: JSON

### [Deployed Link](https://stark-taiga-57338.herokuapp.com/)
### [GitHub repository](https://github.com/espinbrandon49/stark_bare_notes)

## Table of Contents
* [Usage](#usage)
* [Demo Video](#demo)
* [Installation](#installation)
* [License](#license)
* [Contributing](#contributing)
* [Collaboration](#collaboration)
* [Questions](#questions)

## Usage
* Enter a new note title and the note text, then a Save icon appears in the navigation at the top of the page
* The new note is saved and appears in the left-hand column with the other existing notes
* Click on an existing note title in the list in the left-hand column and that note appears in the right-hand column in full
* Click on the Write icon in the navigation at the top of the page to return to enter a new note title and the note’s text in the right-hand column

## Demo
- ![demo video](./Assets/usageDemo.gif)

## Installation
### Browser
* Runs in the browser
* Deployed Link: [https://stark-taiga-57338.herokuapp.com/](https://stark-taiga-57338.herokuapp.com/)

### Clone
Install node.js and NPM on windows, clone down the GitHub repository and install the npm packages.
1. Download and install [Node.js](https://nodejs.org/en/download/)
2. Clone the repository
```bash
git clone [email protected]:espinbrandon49/stark_bare_notes.git
```
3. Run npm install to install the npm dependencies from the [package.json](./package.json)
```bash
npm install
```

## License
### MIT License
The content of this application is licensed under the MIT License.

[https://choosealicense.com/licenses/mit/](https://choosealicense.com/licenses/mit/)

## Contributing

[Contributor Covenant](https://www.contributor-covenant.org/)

## Collaboration
Jerome Chenette

## Questions

Contact me by [E-mail](mailto:[email protected]) or [GitHub](https://github.com/espinbrandon49)