https://github.com/diegotoral/ann
A super simple and clean notes app
https://github.com/diegotoral/ann
notes ruby-on-rails tailwindcss vuejs
Last synced: about 2 months ago
JSON representation
A super simple and clean notes app
- Host: GitHub
- URL: https://github.com/diegotoral/ann
- Owner: diegotoral
- License: mit
- Created: 2019-06-07T21:42:53.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-19T13:22:22.000Z (over 2 years ago)
- Last Synced: 2025-01-17T15:16:42.881Z (4 months ago)
- Topics: notes, ruby-on-rails, tailwindcss, vuejs
- Language: Ruby
- Size: 3.76 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**ANN** is a super simple and clean notes app. It aims to be a replacement to other notes taking apps but keep a very clean set of features. **ANN** will eventually support Markdown.
**ANN** is built with a mix of [Rails 5](https://rubyonrails.org), [Tailwindcss](https://tailwindcss.com), and [Vue.js](http://vuejs.org).
## Getting Started
### Prerequisites
- [Ruby](https://www.ruby-lang.org/en/) - we recommend using [rmv](http://rvm.io)
- [Yarn](https://yarnpkg.com/)
- [PostgreSQL](https://www.postgresql.org/) 9.4 or higher
### Standard Installation
1. Make sure all the prerequisites are installed
2. Fork or clone this repository
3. Run `bin/setup`
4. That's it! Start the application and head to `http://localhost:3000`
### Hybrid Docker Installation
1. Install `docker` and `docker-compose`
2. Fork or clone this repository
3. Run `docker-compose up`
4. Run `bin/setup`
5. That's it! Start the application as you normaly do and head to `http://localhost:3000`
## License
**ANN** is released under the [MIT License](https://opensource.org/licenses/MIT).