Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 1.61 KB

README.md

File metadata and controls

66 lines (44 loc) · 1.61 KB
Raw
Logo

nin0chat

The chat app of all time. Easy to use, simple and open.

📝 Table of contents

🧐 About

nin0chat is a silly simple chatroom that allows people to easily join just by opening the website and starting to chat. The goal is to have IRC, but better. This project was built using TypeScript, Fastify, and Postgres.

Thanks to all the contributors who helped make this project possible!

🚀 Get started

As a user: go to https://chat.nin0.dev. As a selfhoster:

Self-hosting guide To get started with nin0chat, you will need to have the following installed on your machine:
  • Node.js
  • pnpm
  • Postgres

Once you have the above installed, you can clone the repository and install the dependencies:

git clone https://github.com/nin0chat/rewrite.git
cd rewrite
pnpm install

After installing the dependencies, there will be a config.example.ts file in the root directory. You will need to copy this file to config.ts and fill in the necessary variables.

Once you have filled in the variables, you can run the following command to start the server:

pnpm dev

or:

pnpm build && pnpm start

if you are running a production instance.

You should then be able to access the server on your desired port.

📜 License

This project is licensed under the AGPL-3.0 License - see the LICENSE file for details.