starwiz-7 / codestream-server

Codestream-server

Server code for codestream

Demo · Report Bug · Request Feature

About The Project

Codestream is a collaborative code-editor which can be used by remote teams to work on the code together. This repository contains the server-side code for codestream.

Built With

• Express.js
• Node.js
• Socket.io

Getting Started

Prerequisites

For development, you will only need Node.js and a node global package, npm, installed in your environement.

Node

• Node installation on Windows

Just go on official Node.js website and download the installer.

Also, be sure to have git available in your PATH, npm might need it (You can find git here).

• Node installation on Ubuntu

You can install nodejs and npm easily with apt install, just run the following commands.

$ sudo apt install nodejs
$ sudo apt install npm

• Other Operating Systems

You can find more information about the installation on the official Node.js website and the official NPM website.

If the installation was successful, you should be able to run the following command.

$ node --version

v8.11.3

$ npm --version

6.1.0

If you need to update npm, you can make it using npm! Cool right? After running the following command, just open again the command line and be happy.

$ npm install npm -g

Installation

1. Clone the repo

   git clone https://github.com/starwiz-7/codestream-server.git

2. Install NPM packages

   npm install

3. Create a .env file and enter

   CLIENT_URL=http://localhost:3000
   JDOODLE_CLIENT_ID=YOUR JDOODLE CLIENT ID
   JDOODLE_CLIENT_SECRET=YOUR JDOODLE CLIENT SECRET

Roadmap

See the open issues for a full list of proposed features (and known issues).

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

License

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

Contact

Aryan Yadav - @7Aryany - [e-mail]

Project Link: https://github.com/starwiz-7/codestream-server

Deployment