Howling Moon

Say goodbye to scattered notes and fragmented ideas
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

There are many great note taking apps out there (Notion, OneNote, ...); however, none really suited my needs so I created this one. I wanted a note taking app that would make me want to go back and reread my thoughts. An app that would help me use those ideas in my work or hobbies.

How does Howling Moon do that?:

• Lets you focus on recording ideas
• Eliminates the time you spent trying to retrieve your thoughts
• Displays all of your thoughts in a more intuitive way making them easier to utilise

(back to top)

Some Screen Shots of the App

Built With

• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Made with

ruby 3.1.2p20

and

Rails 7.0.4.2

Installation

1. Clone the repo

   git clone https://github.com/LucasNseyep/howling-moon.git

   or

   git clone [email protected]:LucasNseyep/howling-moon.git

2. Install ruby gems

   bundle install

3. Install yarn packages

   yarn install

4. Create the database and populate it

   rails db:create db:migrate db:seed

5. Run the app

   bin/dev

(back to top)

Usage

(back to top)

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

(back to top)

Roadmap

• Figma of the core user journeys (creating and displaying thoughts, and displaying collections)
• MVP for the midway demo
• MLP (Minimum Lovable product) for the final demo

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature 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

(back to top)

Contact

Lucas Nseyep - [email protected]

(back to top)

Acknowledgments

• Carolina Bacelar
• Enyo Ha
• Pedro Tasca
• Arman Akhter

(back to top)