- About the Project
- Features
- Technologies Used
- Architecture
- Installation
- Usage
- Screenshots
- API Documentation
- Testing
- Contributing
- Roadmap
- License
- Contact
PSIX is a simple clone of X. It replicates the core functionality of X with additional features such as new AI chat model. The goal of this project is to make a new developer portfolio template.
- [Feature 1: Profile]
- [Feature 2: Grok-AI chat]
- [Feature 3: Twitt post & react]
- [Feature 4: Post like or follow users]
- Frontend: [ React, Nextjs]
- Backend: [ Supabase ]
Provide a high-level overview of the system architecture. Include diagrams if possible.
Example:
- Frontend: Handles user interface and communicates with the backend via REST/GraphQL APIs.
- Backend: Processes business logic and serves data to the frontend.
- Database: Stores user data, application state, embedding data etc.
- Clone the repository:
git clone https://github.com/CodeVoyager15/PSIX.git
- Navigate to the project directory:
cd clone-x
- Install dependencies:
npm install
- Set up environment variables:
- Create a .env file in the root directory.
- Add the following variables:
- Run the application:
npm run dev
- Open the application in your browser at http://localhost:3000.
- Signup with your gmail (OAuth 2 not firebase auth)
- Post or reply twitts
- Run unit tests:
npm test
- Run integration tests:
npm run test:integration
- View test coverage:
npm run coverage