Code Monkey home page Code Monkey logo

darkrai-server's Introduction

Darkrai Server

The server component for the Darkrai browser extension.

You can find the repository for the extension here.

Darkrai is a browser extension which enables you to chat with anybody visiting the same website ๐Ÿคฉ

Development

Darkrai uses a docker container configuration for both development (using vscode) and production. Hence we recommend you install docker. Learn more here.

Environment file

You need to setup a .env file in the root of the repository. The file should look like this:

DB_URL=#Your database url here
DB_NAME=#Your database name here
NODE_ENV=#Your node environment mode (development or production)
SERVER_SECRET=#A random string

Docker

  • To develop in docker with vscode you need to have the Remote-Containers extension installed.
  • After installing the extension open the command palette and select the "Open folder in Container" option which will open your folder in the docker container.
  • Once the image is built and your vscode window is open in the container, open a terminal (in vscode) and run yarn dev and you are good to go.

Regular

You need the following dependencies installed on your machine:

  • NodeJS
  • Yarn

Run the following commands in the cloned repository:

# To install node dependencies
yarn
# To run the dev server
yarn dev

Production

For production, we highly recommend using docker, however if you want to run the server without docker than you will need to install the dependencies mentioned in this section and then just run yarn start in the repo folder.

For docker users:

  • First, build the image:

    docker build -t darkrai .
  • Run the image while mapping the port to the host machine:

    docker run -p 4848 darkrai

darkrai-server's People

Contributors

statebait avatar smit2k14 avatar hitgo00 avatar dependabot[bot] avatar saifkotwal avatar

Stargazers

Lav Senghani 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.