Z Platform

Twitter Clone with NextJS and Tailwind!

Report Bug • Demo

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Deployment
4. Contributing
5. License
6. Contact
7. Disclaimer

About The Project

This is a Twitter Clone built with NextJS and Tailwind. Mainly created this project for my university project, but feel free to uss it for your own purposes.

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

1. Create an .env file in your root directory and it should contain:

DATABASE_URL="postgresql://postgres:USER@HOST:PORT/DATABASE?schema=YOUR_SCHEMA_NAME" #postgres
NEXTAUTH_SECRET="NEXTAUTH_SECRET" #can be anything
NEXTAUTH_URL="http://192.168.#.#:3000" #should be replaced with your website domain when shipped to production

This Project was made with postgres as the database, configure Prisma if you plan to use a different database

2. Install Node Package Manager or npm if you don't have it on your device.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/Aking16/z-platform.git

2. Install NPM packages

   npm install

3. Run the website on your localhost

   npm run dev

(back to top)

Deployment

I have deployed this project on Vercel, however this project can be deployed on any other hosting services that you prefer.

CAUTIONS
If you wish to deploy this project on Vercel, please use the vercel branch as it's deployment ready for Vercel.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

My Discord - akingg

Project Link: https://github.com/Aking16/z-platform

(back to top)

Disclaimer

This project isn't allowed to be used for fishing or other illegal activities that may relate to the actual Twitter

(back to top)