Skip to content

Latest commit

 

History

History
59 lines (49 loc) · 1.69 KB

README.md

File metadata and controls

59 lines (49 loc) · 1.69 KB
Raw

README

Introduction

Notes is a refreshing and user-friendly application designed to provide a seamless note-taking experience. This application stands out as an alternative to Google Keep and Apple Notes, offering an open and flexible platform for all users, irrespective of their device ecosystem.

Features

  • Easy Note Management: Create, edit, and delete notes effortlessly.
  • Rich Text Support: Enhance your notes with rich text formatting.
  • Cross-Platform Accessibility: Access your notes from any device.
  • Secure & Private: Your notes are stored securely and kept private.

Getting Started

Prerequisites

  • Ruby 3.3.0
  • Rails 7.1
  • PostgresSQL 14.10

Installation

  1. Clone the repository: 
    git clone https://github.com/joel/notes.git
  2. Navigate to the application directory: 
    cd notes
  3. Install dependencies: 
    bundle install
  4. Setup the database: 
    rails db:create
rails db:migrate

Running the Application

  1. Start the Rails server: 
    rails s
  2. Open your browser and navigate to http://localhost:3000.

Contributing

Contributions to improve Notes are welcome. Please follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/AmazingFeature).
  3. Commit your changes (git commit -m 'Add some AmazingFeature').
  4. Push to the branch (git push origin feature/AmazingFeature).
  5. Open a Pull Request.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Joel A. - [email protected]

Project Link: https://github.com/joel/notes