Giter Club home page Giter Club logo

chatcube's Introduction

Chat Cube (open source)

We are going to create a pr. You need to know basic git and github commands to make a pr. If you don't know about it, check my Git and Github crash course

Click on fork in the top left corner of your screen. Clone the repo you have been redirected to

git clone url_redirected_to

Installing dependencies

If you use yarn then run

yarn install

This project is using yarn so stick to yarn

Creating a new branch

git checkout -b new-feature

Starting server

If you are using yarn then run

yarn dev

and if you using npm run

npm run dev

Configuring Clerk

Checkout this article to configure Clerk

Setting up firebase

Creating a project

Go to Firebase

  • Sign up/in and click on create a project. You can name it anything I will name it chat app.

Firebase

  • Leave everything as default and click continue

Creating a web app

  • After the project has been created. Click on the web icon. Icon

Give it the same name as your project and you can leave everything as default.

web app

Getting the config

After this is done click on the web app with the name you gave and then click on settings. web app icon

  • Create a file .env.local and add this Env
FIREBASE_AUTH_DOMAIN=chat-app-489ee.firebaseapp.com
FIREBASE_PROJECT_ID=chat-app-489ee
FIREBASE_STORAGE_BUCKET=chat-app-489ee.appspot.com
FIREBASE_MESSAGEING_SENDER_ID=620872866119
FIREBASE_APP_ID=1:620872866119:web:a02c63f5db95893b9f5462
  • Scroll down to config and

  • Replace the env variables with your keys as named.

Setting up db

  • Go to firestore db tab in the sidebar
  • Click on create database and then click on test mode. db

Setting up storage

  • Go to stiarge tab in the sidebar
  • and change the rules to allow read and write
rules_version = '2';
service firebase.storage {
  match /b/{bucket}/o {
    match /{allPaths=**} {
      allow read, write;
    }
  }
}

Restart the server

  • Kill the current server and start a new server

If you are using yarn then run

yarn dev

๐Ÿ›ก๏ธ License

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

Adding features

Now if you login then the recipients and users list will be empty.

You can use some accounts to test your features.

Creating a PR

Checkout this article to make a PR

You have successfully created a pull request and I will review and merge it soon.

Contributors

chatcube's People

Contributors

avneesh0612 avatar lorstenoplo avatar rozen2007 avatar aman-janwani avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.