KaProDes / storymarker

Made for small teams to internally share designs, mockups and code.

StoryMarker

Made for small teams to internally share designs, mockups and code.
Jump to Project Source »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

While working on an App Idea with a small-medium team, it often gets tedious to haul code snippets around, write todos for features, distribute mockups and track progress of the UI/UX development. StoryMarker allows you to do all of the above, so that you can work on the next big thing without losing track of that Figma Design that Eve shared with you last Thursday!

Features of StoryMarker:

• Rich Text Editor with Markdown support so that you can write Stories with maximum control.
• auth0 Authentication with customizable Role control (Admin/User/Others)
• Created by Software Engineers like you. We have painstakingly created a beautiful seamless, familiar-feeling experience using Bootstrap 5 that doesn't get in the way Know More »

Building a collaboration software is a continuous process and requires iterative improvements and matures over time. We will be updating the features on the backend per the issues/user feedback and we aim to make StoryMarker an essential tool in a small Team's arsenal

Authorization Features :

Visit StoryMarker to check it out now!

(back to top)

Built With

This project is made with :

• Bootstrap 5
• Node JS
• Express JS
• Marked
• Mongo DB
• ejs
• auth0

(back to top)

Getting Started

Before you start working on this project/fork it, it is highly recommended that you check out how the models and the backend works here : Source

We can clone the entire project 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.

• NodeJS version 14 or greater

  node -v

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 https://github.com/KaProDes/storymarker.git

2. Install all necessary node modules

   npm install

3. Create a .env file and add the following Do note that you will require your own MongoDB Instance and auth0 server

   ISSUER_BASE_URL=https://johndoe.us.auth0.com
   CLIENT_ID=FmS123459y0HXpa234xlDZIVElgraY65
   BASE_URL=http://localhost:3000
   SECRET=NbAtMbK2fCkgQ1otjStjClwev2oDnVPTQtomhollandbp37STlIzHFo3Zz3A8CB
   URI=mongodb+srv://johndoe:<password>@cluster0.ifsn5.mongodb.net/Stories?retryWrites=true&w=majority

4. Launch the Project on default port 3000

   npm run dev

(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

I, KaProDes, give anyone and everyone the freedom to use this Project. Free to use. Credits appreciated.

(back to top)

Contact

Your Name - @KapProDes - [e-mail]

Project Link: https://github.com/KaProDes/storymarker

(back to top)

Acknowledgments

Special thanks to all my teachers and mentors. I have made this project as part of my practical learning.

• Colt Steele
• CodeDamn
• CodeStackr
• freecodecamp

(back to top)