/komotria

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Komotria

*hairdresser*

An anonymous messaging site for sharing various personal and non-personal stories
View Demo · Report Bug · Request Feature

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

About The Project

Komotria (greek word) is an anonymous messaging site for sharing various personal and non-personal stories for fun or help. These stories could be anything from a breakup, a tyn, a unique problem, etc...
The site will have some auto-moderation tools and active moderators to ensure everything runs smoothly.

(back to top)

Built With

  • nodeJS
  • Bootstrap
  • JQuery
  • MongoDB

(back to top)

Getting Started

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

  1. Clone the repo 
    git clone https://github.com/Glutius/komotria.git
  2. Install NPM packages 
    npm install
  3. Rename the '.env.sample' to '.env'
  4. Enter your MONGO_uri for the database, in .env 
    API_PORT=3000
MONGO_URI=
  5. To run the project, run one of the following commands: 
    npm run start
npm run dev //To run with nodemon

(back to top)

Usage

Usage examples will be added later on.

(back to top)

Roadmap

  • Get a first idea of the layout
  • Create the layout with Bootstrap
  • Basic backend functionality
    • Nested Feature

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)

License

Distributed under the GNU General Public License v3.0 License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/Glutius/komotria

(back to top)

Acknowledgments

(back to top)