Skip to content

templarmanatee/Remarque

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues ClosedRequests MIT License


Logo

Remarque

Simply put - a bullet journal application
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

alt text alt text

about remarque...

(back to top)

Built With

a list of major frameworks/libraries used to bootstrap your project

  • Vite
  • React
  • Tailwindcss
  • JWT
  • Express.js
  • MongoDB

(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

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

  1. Clone the repo
    git clone git@github.com:templarmanatee/Remarque.git
  2. Install NPM packages
    npm run install
  3. Download MongoDB
    https://www.mongodb.com/docs/manual/installation/
    
  4. Build page
    npm run develop

(back to top)

Usage

Remarque is useful for: taking notes, scheduling events, and making lists.

(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)

License

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

(back to top)

Contact

Project Link: https://github.com/mhengerer/Remarque

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)

Packages

No packages published

Languages

  • JavaScript 91.8%
  • CSS 7.4%
  • HTML 0.8%