Skip to content

A personal blogging website to publish articles ๐Ÿ“ ๐Ÿ’ป

Notifications You must be signed in to change notification settings

0xrishavsharma/text-tango

Repository files navigation

Blog Website

This is a blog website built using Next.js with its SSR and SSG capabilities. It uses Prisma as an ORM and Next-Auth for authentication. It also uses Firebase for image storage and Framer Motion for animations.

System Requirements

  • A PC with internet connection
  • Node.js version 14 or higher
  • Yarn package manager version 1.22.0 or higher

Installation Instructions

  1. Clone the repository to your local machine using git clone https://github.com/0xrishavsharma/text-tango.
  2. Navigate to the project directory using cd text-tango.
  3. Install the project dependencies using yarn or yarn install.
  4. Start the development server using yarn dev.

Usage Instructions

  1. Open your web browser and navigate to http://localhost:3000.
  2. Explore the blog posts on the homepage.
  3. Click on a blog post to read it in detail and leave comments.
  4. Click on the "Write" button to create a new blog post.

Technologies Used

This project uses a number of technologies to work properly:

  • Next.js: A popular React framework for building web applications.

  • Tailwind CSS: A utility-first CSS framework for rapidly building custom user interfaces.

  • Prisma: An open source database independent ORM.

  • React-Quill: A React component for the Quill Rich Text Editor.

  • Framer Motion: A production-ready library for adding animations.

  • React-Icons: A collection of popular icons.

  • Next-Auth: An authentication library for Next.js.

  • Prettier: An opinionated code formatter.

  • ESLint: A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript.

  • Husky: A tool that makes it easy to use githooks as if they are npm scripts.

  • Yarn: A fast, reliable, and secure dependency management tool.

  • Firebase: A platform developed by Google for creating mobile and web applications. It is used in this project for image storage.

  • Git: A free and open source distributed version control system.

Contribution Guidelines

We welcome contributions from everyone. If you're interested in contributing:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Make your changes and commit them to your forked repository.
  4. Submit a pull request with your changes.

Contact Information

For more information or for reporting issues, feel free to create a pull request. You can also reach out to me through the following platforms:

Acknowledgements

This project was built while following the tutorial Full-Stack Blog App Tutorial from Lama Dev's Youtube channel. I would like to express my gratitude to Safak for providing such a comprehensive and easy-to-follow video on this topic.

If you're interested in building a similar project, I highly recommend checking out this tutorial.

Usage

This code is free to use by anyone for any purpose, and it comes with no warranties. No need for attribution or any restrictions.

About

A personal blogging website to publish articles ๐Ÿ“ ๐Ÿ’ป

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published