Ace-It Articles

Share your valuable knowledge and experience with others
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

Unlease your creativity with Ace-It Articles, minimal design, adfree and free limit of posting articles

Here's why:

• Developed a distributed platform to help individuals to share their knowledge with others with no additional subscription.
• Established multiple functionalities to support individual user contributions and an admin panel to issue the articles.
• A simplier minimalistic user interface with 0 ads.

follow this README.md file for get started

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Follow this instructions and setup this project on your system locally

Prerequisites

Node.js and MongoDB should be installed in your system.

Don't forget to set environment variables of PORT and MONGO_URI.

Installation

1. Clone the repo

   git clone https://github.com/subh-23/Ace-It-Articles.git

2. Install NPM packages

   npm install

3. Create .env file in the parent file directory and copy this

   const PORT = 3000
   const MONGO_URI = 'mongodb://localhost:27017/myapp'

4. Start the server

   npm start

(back to top)

Roadmap

• Better user interface
• Post articles with images
• Permession based login with security
  • User can edit and delete their own articles
  • Admin can delete everyones articles
  • No any user can delete and edit other user's articles
• Random generated avatar
• Include like and comment on each articles
• Users can follow fellow users
• Search Bar

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 Apache License. See LICENSE for more information.

(back to top)

Contact

Subhodip Roy - @23_subh - subhodiproy281@gmail.com

Project Link: https://github.com/subh_23/Ace-It-Articles

(back to top)

Acknowledgments

• Web Dev Simplified
• FlowBite
• REST API

(back to top)