Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/egarrisxn/egxsocial
A Social Thing.
https://github.com/egarrisxn/egxsocial
nextjs nextjs15 react react19 reactjs shadcn-ui supabase tailwind tailwindcss typescript
Last synced: about 2 months ago
JSON representation
A Social Thing.
- Host: GitHub
- URL: https://github.com/egarrisxn/egxsocial
- Owner: egarrisxn
- License: mit
- Created: 2024-11-12T05:25:25.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-12T06:15:41.000Z (about 2 months ago)
- Last Synced: 2024-11-12T06:25:10.657Z (about 2 months ago)
- Topics: nextjs, nextjs15, react, react19, reactjs, shadcn-ui, supabase, tailwind, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://egxsocial.vercel.app
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# egxsocial
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) ![GitHub repo size](https://img.shields.io/github/repo-size/egarrisxn/egxsocial) ![GitHub last commit](https://img.shields.io/github/last-commit/egarrisxn/egxsocial)
## Table of Contents
- [Overview](#overview)
- [Technologies](#technologies)
- [Features](#features)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Usage](#usage)
- [Deployment](#deployment)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)## Overview
**TBD**
## Technologies
- **Framework**: [Next.js 15](https://nextjs.org/)
- **Programming Language**: [TypeScript](https://www.typescriptlang.org/), [JavaScript (React 18)](https://reactjs.org/)
- **Styling**: [Tailwind CSS](https://tailwindcss.com/)
- **Database**: [Supabase](https://supabase.com/)
- **TBD**## Features
**TBD**
## Getting Started
To get a local copy up and running, follow these simple steps.
### Prerequisites
- **Node.js** (v18 or higher)
- **pnpm** (recommended for package management)## Installation
1. Clone the repo:
```bash
git clone https://github.com/yourusername/egxsocial.git
```2. Navigate to the project directory:
```bash
cd egxsocial
```3. Install dependencies:
```bash
pnpm install
```## Usage
- To run the development server:
```bash
pnpm dev
```- To build the project for production:
```bash
pnpm build
```- To start the production server:
```bash
pnpm start
```- To lint the project:
```bash
pnpm lint
```- To format code with Prettier:
```bash
pnpm format
```## **Deployment**
Deploy the project on a hosting platform that supports Next.js, such as Vercel, Netlify, or any other cloud provider. Ensure you have set up your environment variables correctly on the hosting platform.
## **Contributing**
Contributions are welcome! If you have suggestions or improvements, feel free to fork the repository and submit a pull request.
## **License**
This project is licensed under the [MIT license](https://opensource.org/licenses/MIT).
## **Contact**
If you have any questions or need further assistance, feel free to reach out via GitHub: [egarrisxn](https://github.com/egarrisxn) and/or Email: [[email protected]](mailto:[email protected]).