NotDiscord

NotDiscord is a Discord clone made with React!

View Demo (Soon) · Report Bug

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. Contact
5. Acknowledgments

About The Project

SoonTM

(back to top)

Built With

(back to top)

Getting Started

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

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Node.js

  https://nodejs.org/en/download/

• yarn

  npm install yarn -g

• MongoDB

  https://www.mongodb.com/docs/manual/installation/

Installation

Clone the repo

git clone https://github.com/eckzzo/notdiscord.git

Server

1. Install packages

   yarn install

2. Copy the .env.example

   yarn copy-env

3. Fill the .env file

   PORT=
   JWT_SECRET=
   MONGO_URI=

4. Start the server

   yarn dev

Web

This package is dependant on the server

1. Install packages

   yarn install

2. Copy the .env.example

   yarn copy-env

3. Fill the .env file (You can leave the other options empty, in case you want to try out the image api feel free to contact me!)

   NEXT_PUBLIC_GRAPHQL_ENDPOINT=

4. Get the GraphQL Schema from the server. The server must be running before you run this command

   yarn get-schema YOUR_GRAPHQL_ENDPOINT

5. Generate relay types

   yarn relay

6. Start!

   yarn dev

(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)

Contact

Eckzzo#8147 (discord) - [email protected]

Project Link: https://github.com/eckzzo/notdiscord

(back to top)

Acknowledgments

• Radix
• Stitches
• Tailwind
• README Template
• jantimon for the NextJS Relay implementation demo!
• sibelius for the amazing Relay Workshop!

(back to top)