You will need the following tools:
- Node.js and npm (Node comes with npm installed)
- Text Editor (e.g., Visual Studio Code)
To install, follow these steps:
Via github:
- Clone the repo:
git clone https://github.com/{YOUR_USERNAME}/operational-transform-server.git - Navigate to the project folder:
cd operational-transform-server - Install the dependencies:
npm install
The following scripts are available:
npm run test: Runs tests using Jest.npm run build: Compiles TypeScript code to JavaScript.npm run dev: Runs the application using nodemon for hot reloading.npm run start: Starts the compiled JavaScript application.
Here are some of the key dependencies that you should be aware of:
express: A minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications.jsonwebtoken: An implementation of JSON Web Tokens. This is used to create access tokens for your applications.quill-delta: A utility for working with Quill's Delta format.i: A utility library for writing idiomatic JavaScript.npm: A package manager for the JavaScript programming language. It is the default package manager for the JavaScript runtime environment Node.js.
These are the development dependencies:
@types/*: TypeScript type definitions for various libraries. This helps with autocompletion and type checking.eslint: A tool for identifying and reporting on patterns found in ECMAScript/JavaScript code.jest: A delightful JavaScript Testing Framework with a focus on simplicity. It is used for writing and running tests.prettier: An opinionated code formatter. It enforces a consistent style by parsing your code and re-printing it with its own rules.supertest: A high-level abstraction for testing HTTP, while still allowing you to drop down to the lower-level API provided by superagent.ts-jest: A TypeScript preprocessor with source map support for Jest that lets you use Jest to test projects written in TypeScript.ts-node: TypeScript execution environment and REPL for node.js, with source map support.typescript: The TypeScript language.
This project is licensed under the ISC License.
For those who would like to contribute, please follow these general guidelines:
- Fork the project
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a pull request
Tests can be run with npm run test and are written with Jest. Please add tests for new features and ensure that these tests are passing before submitting pull requests.
Please add contact information.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. In case of abusive behavior, please report it by contacting the project team.