/websocial

Web Social is a web application built with Next15 that provides a modern and efficient way to manage and organize your resources. The project is configured with TypeScript, ESLint, and Tailwind CSS for enhanced development and styling capabilities.

Primary LanguageTypeScript

Web Social

Web Social is a web application built with Next15 that provides a modern and efficient way to manage and organize your resources. The project is configured with TypeScript, ESLint, and Tailwind CSS for enhanced development and styling capabilities.

Table of Contents

Features

  • React: Frontend framework for building user interfaces.
  • Nextjs: Optimized build tool and development server.
  • TypeScript: Strongly typed JavaScript for type safety.
  • Tailwind CSS: Utility-first CSS framework for rapid UI development.
  • ESLint: Linting tool for identifying and fixing problems in JavaScript code.
  • PostCSS & Autoprefixer: CSS processor for transforming styles and adding vendor prefixes.

Getting Started

To get a local copy of the project up and running, follow these steps:

Prerequisites

Make sure you have Node.js installed. You can download it from Node.js official website.

Installation

  1. Clone the repository: 
    git clone https://github.com/gift56/websocial.git
  2. Navigate into the project directory:
  cd websocial
  1. Navigate into the project directory:
  npm install

Running the Project

To start the development server, run the following command:

  npm run dev

The app will be available at (http://localhost:3000)[http://localhost:3000].

Project Structure

  websocial/
├── public/           # Static files
├── src/              # Source code
│   ├── components/   # React components
│   ├── app/          # Nextjs Folder based Route
│   ├── app/styles/   # CSS and Tailwind CSS files
├── package.json      # Project configuration and dependencies
└── next.config.mjs    # next configuration

Available Scripts

In the project directory, you can run the following scripts:

  • npm run dev: Starts the development server.
  • npm run build: Builds the app for production.
  • npm run lint: Lints the project files.
  • npm run preview: Previews the production build locally.

Dependencies

  • react: ^18.3.1
  • react-dom: ^18.3.1
  • babel-plugin-react-compiler: ^0.0.0-experimental-938cd9a-20240601
  • DevDependencies
  • @types/node: ^20
  • @types/react: ^18
  • @types/react-dom: ^18
  • eslint: ^8
  • eslint-config-next: 15.0.0-rc.0
  • postcss: ^8.4.47
  • tailwindcss: ^3.4.11
  • typescript: ^5.5.3

Contributing

License

This project is licensed under the MIT License - see the ()[LICENSE] file for details.

This `README.md` gives a clear overview of your project, including setup instructions, features, and contribution guidelines. You can adjust any details as needed for your specific project!