Skip to content

Latest commit

 

History

History
167 lines (110 loc) · 4.55 KB

README.md

File metadata and controls

167 lines (110 loc) · 4.55 KB
Raw

--> [![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url] [![LinkedIn][linkedin-shield]][linkedin-url]


Logo

Blog Website

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

About The Project

This web app a full-stack blogging website where you can create an account and start writing posts, follow users, comment, like, and many more things. This web app is built with Nextjs13(front-end and back-end part) so no nodejs or epxressjs is used for this project. For styling i used tailwindcss and for icons i used heroicons.com. And finally this project is compatible with nextjs13.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

  • Next
  • React

(back to top)

Getting Started

Setting up the project.

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

change the mongodb url to one of your own cluster and whitelist your ip address in the mongodb website settings.

  1. Clone the repo 
    git clone https://github.com/AliSinaYOusofi/BlogSite
  2. Install NPM packages 
    npm install

(back to top)

Usage

open your terminal/powershell and type: npm run dev.

(back to top)

Roadmap

  • Add Changelog
  • Add back to top links
  • Add Additional Templates w/ Examples
  • Add "components" document to easily copy & paste sections of the readme

(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.txt for more information.

(back to top)

Contact

Ali Sina Yousofi - @RippedDeveloper - tinayousofiali@gmail.com

Project Link: https://github.com/AliSinaYOusofi/BlogSite

(back to top)