https://github.com/paroi-tech/smallteam
A rudimentary task management software for small teams.
https://github.com/paroi-tech/smallteam
Last synced: 13 days ago
JSON representation
A rudimentary task management software for small teams.
- Host: GitHub
- URL: https://github.com/paroi-tech/smallteam
- Owner: paroi-tech
- Created: 2017-01-14T07:44:34.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-07-19T15:35:02.000Z (almost 6 years ago)
- Last Synced: 2025-05-10T13:03:08.024Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 5.63 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SmallTeam
[](https://travis-ci.com/paroi-tech/smallteam)
A rudimentary task management software for small teams.
This is the software of https://smallteam.paroi.tech/
## Daily use commmands on a local development environment
In a terminal:
```sh
(cd packages/smallteam && rushx serve)
```
In the vscode's terminal, run one of these commands:
```sh
# Work on Team
(cd subprojects/team-frontend && rushx watch)
# Work on Platform
(cd subprojects/platform-frontend && rushx watch)
# Work on Registration
(cd subprojects/registration-frontend && rushx watch)
```
After changing a `package.json` or a `git pull`:
```sh
rush update
rush rebuild
```
After running a `npm` command by mistake, it is necessary to clean up all `node_modules` directories the Rush way:
```sh
rush update --recheck
```
Run the linter everywhere:
```sh
rush lint
```
## Deploy
Stop dev watchers for backend and frontends, then, execute one of these commands:
```sh
# Bump version's patch number
rush new-release
# Bump version's minor number
rush new-release --minor
# Bump version's major number
rush new-release --major
```
## Install a local development environment
### Installation, part 1
Redirect `smallteam.paroi.local` to localhost. Create domains for `team1` and `team2`.
```
$ sudo vi /etc/hosts
# Append:
127.0.0.1 smallteam.paroi.local
127.0.0.1 team1.smallteam.paroi.local
127.0.0.1 team2.smallteam.paroi.local
```
Then, some configuration:
```sh
mkdir data
cp smallteam/config.local.json smallteam/config.json
```
### Rush
Install `@microsoft/rush` and `pnpm` globally:
```sh
sudo npm i pnpm @microsoft/rush -g
```
See also:
* [Modifying package.json](https://rushjs.io/pages/developer/modifying_package_json/)
* [Everyday commands](https://rushjs.io/pages/developer/everyday_commands/)
* [Other helpful commands](https://rushjs.io/pages/developer/other_commands/)
* [NPM vs PNPM vs Yarn](https://rushjs.io/pages/maintainer/package_managers/)
Now, make sure you never use _npm_ directly on this monorepo. Use only **rush**.
Warning: On Ubuntu, the snap version of Node.js is buggy. Here is how to reinstall Node using nodesource:
```sh
sudo bash
snap remove node
curl -sL https://deb.nodesource.com/setup_12.x | bash -
apt install -y nodejs
```
### Installation, part 2
Now, install and build all the subprojects:
```sh
rush install
rush build
```
Now, start the backend:
```sh
(cd packages/smallteam && rushx serve)
```
Then, load the platform frontend: http://smallteam.paroi.local:3921/
And create a new `team1` or `team2`. The confirmation e-mail will be in logs, level INFO.