Code It Down

This Project is a Personal Blog Platform for someone who is looking to manage everything at their hands. This project cantains every page that a Blog should contain like HomePage, Blog Page, About me Page, Hashtags and Cateogary Page, Contact Page.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

(back to top)

Built With

• 
• 

(back to top)

Getting Started

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

Prerequisites

This is a List of Software that should be installed on a system in order to run this project locally.

• npm

  npm install npm@latest -g

Installation

1. Get a all the enpoints listed in local.env and the URL to the backend also
2. Clone the repo

   git clone https://github.com/coderaman7/codeitdown.git

3. Install NPM packages

   npm install

4. Create and Enter your API in .env.local as specified in local.env.

    cateogary = <Cateogary Endpoint>
    recentPost = <Trending Endpoint>
    editorsPick = <Editors Pick Endpoint>
    recomendedTopics = <Recomended Blogs Endpoint>
    popularPosts = <Popular Blogs Endpoint>
    randomCateogary = <Random Blogs Endpoint>
    recentBlogPosts = <Recent Blogs EndPoint>
    allBlogPost = <All Blogs Endpoint>
    allCategories = <All Cateogary Endpoint>
    allHashtag = <All Hashtags Endpoint>
    searchByPost = <Sub Location of your Blogs>
    getComments = <Get Comments Endpoint>
    hashsearch = <Hashtag Search Endpoint>
    catsearch = <Cateogary Search Endpoint>
    headsearch = <Headline Search Endpoint>
    newsletter = <Newsletter Endpoint>
    likeThePost = <Like the Blog Endpoint>
    previousPost = <Previous Blog Endpoint>
    nextPost = <Next Blog Endpoint>
    contact = <Contact Me Endpoint>
    commentaPost = <Comment on a Blog Endpoint>
    famousCateogaries = <Famous Cateogaries Endpoint>
    blogURLPOST = <URL to the Backend>

(back to top)

Usage

This Project is developed with the users in mind who like to have a complete custom made Blog Website of their own where they can control all the data by himself/herself.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Home Page
• All Blog Posts
• About me
• Contact me
• Hashtag and Cateogary Page
• Custom Blog Post Page
  • Comments
  • Likes
  • Previous and Next Blogs
• Sitemap

To do for this Project

• Documentation about the Backend and the URL Endpoints

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

(back to top)

Contact

Your Name - @BugsOverflow - bugsoverflow@gmail.com

Project Link: https://github.com/coderaman7/codeitdown

(back to top)