Skip to content

Apocalypse3007/WordWhirl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Blogging App

Welcome to the Blogging App! This application is a modern platform that allows users to sign up, sign in, create, upload, and read blogs. It is built with React for the frontend, Tailwind CSS for styling, and PostgreSQL for the database.

Table of Contents

  1. Features
  2. Tech Stack
  3. Installation
  4. Usage
  5. Contributing

Features

  • User Authentication: Secure sign-up and sign-in functionality.
  • Blog Management: Create, upload, and read blogs with ease.
  • Responsive Design: Beautifully designed UI that works on all devices.
  • Customizable Themes: Tailwind CSS for easy styling and theme management.
  • Database Management: Uses PostgreSQL for robust data handling and storage.

Tech Stack

The Blogging App leverages a modern tech stack:

  • Frontend: React - A JavaScript library for building user interfaces.
  • Styling: Tailwind CSS - A utility-first CSS framework for rapid UI development.
  • Backend: Node.js - JavaScript runtime for server-side development.
  • Database: PostgreSQL - A powerful, open-source object-relational database system.
  • API: Express - A fast, unopinionated, minimalist web framework for Node.js.

Installation

To set up the Blogging App locally, follow these steps:

Prerequisites

Ensure you have the following installed on your machine:

Steps

  1. Clone the repository:

    git clone https://github.com/yourusername/blogging-app.git
    cd blogging-app
  2. Install dependencies:

    npm install
  3. Set up the PostgreSQL database:

    • Create a new database in PostgreSQL:

      CREATE DATABASE blogging_app;
    • Create a .env file in the root directory and add your database configuration:

      DATABASE_URL=postgres://yourusername:yourpassword@localhost:5432/blogging_app
  4. Run database migrations:

    npm run migrate
  5. Start the development server:

    npm start
  6. Visit the app:

    Open your browser and navigate to http://localhost:3000 to see the application in action.

Usage

Once the Blogging App is up and running, you can:

  • Sign Up / Sign In: Create an account or log in to access the full functionality of the app.
  • Create Blogs: Write and publish new blog posts.
  • Read Blogs: Browse through all the published blogs and enjoy the content.
  • Responsive Experience: Enjoy a seamless experience across all devices.

Contributing

We welcome contributions to the Blogging App! If you'd like to contribute, please follow these steps:

  1. Fork the repository by clicking the "Fork" button on GitHub.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/yourusername/blogging-app.git
  3. Create a new branch for your feature or bug fix:

    git checkout -b feature-name
  4. Make your changes and commit them:

    git commit -m "Add some feature"
  5. Push to the branch:

    git push origin feature-name
  6. Create a pull request on GitHub and describe your changes.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published