CityDAO Contract Template
Contract template to setup new smart-contract projects. See Parcel Contracts repo which is forked from this template: https://github.com/citydaoproject/parcel-contracts
Getting Started
Fork and clone this repo https://github.com/citydaoproject/contracts-template.git to begin.
To get a local copy up and running follow these simple example steps.
Prerequisites
Installation
git clone https://github.com/citydaoproject/contracts-template.gitcdto the project directory and execute the following:nvm install nvm use npm install
IDE Setup
This project uses EditorConfig for IDE configuration. (Basic code formatting for maintaining the consistency across all the IDE)
Many popular IDEs and editors support this out of the box or with a plugin.
See .editorconfig for settings.
Prettier
This project uses Prettier, so please run it before checking in:
npm run pretty
See .prettierrc for settings.
Some IDEs and editors have plugins for running Prettier.
Linting
This project uses ESLint. Check linting before checking in:
npm run lint
See tslint.json for settings.
Many IDEs and editors support TSLint.
Testing
This project uses Mocha, Chai, and Waffle for testing. Run tests before checking in.
npm test
Building
npm run build
Roadmap
- Update readme
- Live workshop demo video on YouTube
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!
- 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
Contact
Join #dev channel in CityDAO Discord to get more details about the project and explore more.