Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eclectic-coding/rails-note-app
https://github.com/eclectic-coding/rails-note-app
Last synced: 24 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/eclectic-coding/rails-note-app
- Owner: eclectic-coding
- License: mit
- Created: 2020-08-05T22:00:35.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-22T11:08:45.000Z (about 2 years ago)
- Last Synced: 2024-12-01T12:07:48.575Z (27 days ago)
- Language: Ruby
- Size: 936 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Rails Note Application
[](https://github.com/eclectic-coding/rails-note-app/blob/main/LICENSE)
[](https://github.com/eclectic-coding/rails-note-app/issues)
[](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Feclectic-coding%2Frails-note-app)
Note App allows users to create an account, then the user can create notes to edit, delete, and update as they see fit, via a user dashboard in which they can manage a list of personal notes.
Live Demo: at [Heroku](https://cs-note-app.herokuapp.com/)
## Features
### Login
The My Notes App has a robust user authentication feature including:
- New account registration
- Activation emails to verify the authenticity of the request
- Session tokens created for authorization
- Session cookie used to give the user the ability to be remembered on the site or not
- Password resets request via email authorization
- User Profile edit/updates
### Notes
The notes section includes the following features:
- The note editor is a [Trix-Editor](https://trix-editor.org/) using [Rails ActionText](https://edgeguides.rubyonrails.org/action_text_overview.html)
- The user can create notes which are private and secure from other users
- The user can create, edit, update, and delete their own notes.
- If the user forgets to enter a title, the dashboard is configured to display a 30 character truncated string of the body content.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
If you plan on deploying to Heroku or an other live service, you will need an account at Sendgrid. You can set up the API_KEY in Rails Credentials with the key name `sendgrid_api_key`.
### Installing
Clone this repository to your computer:
```
git clone [email protected]:eclectic-coding/rails-note-app.git
```
Navigate to your newly created directory and run bundle install. Then set up the database:
```
rails db:migrate && rails db:seed
```
Install the gems: `bundle install`
Install the javascript packages: `yarn`, or `npm install`.
The stylesheets are configured in webpacker, so to start the server, in one terminal: `./bin/webpack-dev-server`. Then in a second terminal window: `rails server`
The other option if to start foreman which is preconfigured: `foreman start`.
## Running the tests
The user model has a robust testing suite using the Rails default `minitest`. To run the test: `rails test`, or you can automate the test by using guard that is preinstalled: `bundle exec guard`.
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details about the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
## Authors
* **Chuck Smith** - [Eclectic Coding](https://github.com/eclectic-coding)
See also the list of [contributors](https://github.com/eclectic-coding/this-repo/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details