Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 2.42 KB

README.md

File metadata and controls

75 lines (50 loc) · 2.42 KB

M'Astral

M'Astral is a modern social media platform that allows users to share thoughts, ideas, and connect with others. This project is built with Next.js and leverages various technologies to provide a smooth and responsive user experience.

mastral

Features

  • Authentication: Managed via NextAuth with providers like GitHub, Discord, and Auth0.
  • Thread Management: Create, comment on, and like threads with pagination.
  • Notifications: Receive notifications for interactions on your threads.
  • User Profile: Edit your profile information and manage visibility.
  • Privacy Policy and Terms of Use: Dedicated pages to inform users about data management.

Technologies Used

  • Framework: Next.js (version 14.2.7) for server-side and client-side development.
  • Database: PostgreSQL with Prisma as the ORM for data management.
  • Styles: Tailwind CSS for design and layout.
  • UI: Shadcn UI for UI components.
  • State Management: Context API and hooks for managing application state.
  • Notifications: Shadcn UI for toast notifications.
  • Environment: Use environment variables for secure configuration.

Installation

  1. Clone the repository:

    git clone [email protected]:mathisdev7/M-Astral.git Mastral
cd Mastral

  2. Install dependencies:

    pnpm install

    or

    npm install

    or

    yarn install

  3. Set up environment variables: Rename the .env.example file to .env and configure the variables as needed.

  4. Start the development server:

    npm run dev

    or

    pnpm run dev

    Access the application at http://localhost:3000 to see it in action.

Contributing

Contributions are welcome! Please follow the contribution guidelines in the CONTRIBUTING.md file to propose improvements or report issues.

License

This project is licensed under a CUSTOM License.