Engrave

Best place to brain dump🧠

About The Project

Engrave is note taking app with clean UI and easy to use features. It is built using Nextjs, Tailwind, Firebase and JavaScript.

Built With

Getting Started

To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repo

   git clone https://github.com/avintimilsina/note-app.git

2. Install the project dependencies

       $ npm install

3. Rename the env.example to env.local & update you enviroment variables in all the apps.

   API_KEY = YOUR_API_KEY;

4. Run the following commands to start the development server

   $ npm run dev

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

License

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