This is a template for a WRLD Tech Node TypeScript project. It is intended to be used as a starting point for new projects by WRLD Tech developers.
Clone this repository and use it as a starting point for your new project.
To get started, you will need to install the following:
- Node.js
- Yarn (or NPM)
- TypeScript
To build the project, run the following command:
npm run build
This will compile the TypeScript code into JavaScript and place the output in the dist directory.
To run the project, run the following command:
npm run start
This will run the compiled JavaScript code.
To run the tests, run the following command:
npm run test
This will run the tests using Jest.
To run the linter, run the following command:
npm run lint
This will run the linter using ESLint.
To run the formatter, run the following command:
npm run format
This will run the formatter using Prettier.
To publish the project, run the following command:
npm run publish
This will run the tests, build the project, and publish the project to NPM. Dont do this unless you know what you are doing.
If you would like to contribute to this project, please follow the following guidelines:
- Create a feature branch
- Make your changes
- Create a pull request
- Get your changes reviewed
- Merge your changes into master
This project is licensed under the MIT License - see the LICENSE file for details
License
MIT License
Copyright (c) 2023 WRLD Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.