Our development team used to manage all the team-related stuff using Excel files in a shared drive. I decided, as a side project, to develop a simple SPA that allowed us to get rid of them.
The app consists of 6 main modules:
- A calendar where see relevant common events.
- A Scrum-based work manager.
- Holidays management.
- "Support" management (each day a team member is responsible for the support inbox).
- Special working days management (mainly public holidays).
- An "analytical" module with multiple charts related to the other 5 modules.
One extra module was added due to popular acclaim: Breakfasts management.
Table of Contents:
The app needs to be configured before running it and it can be done in 2 ways:
- Placing a
.envfile inbackend/temat. Example: .env.example - Declaring environment variables (prefixed with
TEMAT_).
| Prefix (for env vars) | Param | Description | Default value |
|---|---|---|---|
| TEMAT_ | ENV | Execution environment. Can be: development or production |
production |
| TEMAT_ | DEBUG | Django debug. Can be: on or off |
off |
| TEMAT_ | SECRET_KEY | Django secret key. MANDATORY. Need a new one? | |
| TEMAT_ | DATABASE_URL | Database connection url. Django environ format | sqlite:///[PROJECT_DIR]/db.sqlite3 |
-
Prerequisites
-
Installing dependencies
cd frontend npm ci cd ../backend pipenv sync --dev
-
Running migrations
cd backend pipenv run python manage.py migrate -
Populating models with initial data
cd backend pipenv run python manage.py loaddata initial_data -
Creating an admin user
cd backend pipenv run python manage.py createsuperuser -
Serving the app
-
Development mode
-
Python shell
cd backend pipenv run runserver -
Node shell
cd frontend npm run serve
-
-
Production mode
-
Build
cd frontend npm run build -
Serve
cd backend pipenv run python manage.py collectstatic --no-input pipenv run serve
-
-
-
Pulling and running the image
docker run -d --name temat --env-file [PATH_TO_ENV_FILE] -p 8000:8000 pablolmedorado/temat:[VERSION]
-
Running migrations
docker exec temat pipenv run python manage.py migrate -
Populating models with initial data
docker exec temat pipenv run python manage.py loaddata initial_data -
Creating an admin user
docker exec -ti temat pipenv run python manage.py createsuperuser
The app has been developed using VS Code Dev Containers. You can use them to run the app: just open the project folder in VS Code and click in "Open in remote container" option.
Doing this you'll create 3 containers:
- PostgreSQL database
- Adminer (database manager)
- VS Code dev container with all the dependencies and extensions installed
Once the dev container is ready, you'll only need to run migrations, populate models, create an admin user and serve the app.
Once the app has been served, it is available at http://localhost:8000/
It's mandatory to populate some database tables before using the app the first time. It can be done by using the django admin, available at http://localhost:8000/admin.
You'll probably want to add event types and user story types, as they're required fields. I decided not to create default records so everyone could customize them.
- This application has been developed with barely Vue.js knowledge. Learning Vue.js was, in fact, the motivation to start developing it. I tried to do my best, but I'm sure there is a bunch of things to improve. I'd like to update the repo with the new good practices I learn. If you want to collaborate, feel free to send a pull request.
- The scope of the application was defined according to my own team's needs. Again, feel free to fork the project and change it if it doesn't fit your team's needs.
- The application doesn't scale well (as it loads the entire user list in the vuex store) neither allow you to manage more than one team. In case you were planning to use it with a big team (>50 people?), I'd change the behaviour of the users dropdown.
- Although the source code is written in english, the app texts are in spanish. I had no time for translate the entire app.
See Changelog.
See License.