CoTrack

Ticket-App using AdonisJs 4.1

Version

0.9 BETA

Languages

• German (default)
• English

Used technologies

• AdonisJs 4.1
• Bulma
• Bulma Extensions
• FontAwesome Free Icons 5.x
• MySQL 5.7.x
• Webpack 4.x
• Simple-DataTables
• SortableJS
• ChoicesJS
• HTML5
• CSS3
• ES6 JavaScript
• Developed under Ubuntu Linux 18.04 with Visual Studio Code

Usage

Install dependencies

npm install

Database setup

Edit your .env file to include the correct DB credentials.

E-Mail setup

Edit your .env file to include the correct SMTP credentials.

Migrations

Run the following command to run startup migrations.

adonis migration:run

Seeding Admin-User

Run the following command to run startup migrations.

adonis seed

Packing Assets

./node_modules/.bin/webpack

Run Server (nodemon suggested)

adonis serve --dev

or

nodemon server.js

Log in as superadmin

• Username (E-Mail): [email protected]
• Password: mfc9Cxs6EdKTt33G

(You can change all informations later in your personal settings)

General settings

On first login as admin you will be redirected to the general settings form. You have to fill in everything. There, among other things, you can change the default language. However, users can choose their own language in their own settings.

API

There can be created Tickets from other Applications. As identifiers are used 3 fields:

E-Mail

The JSON key email will be checked and assigned against a active user in the "intranet" database.

Project

The JSON key project will be checked and assigned against a existing and active project in the database. The request value will be matched with the database field id in the projects-table.

Token

The JSON key token will be checked against a existing project. Each project has his own individual token that will be automatically generated on create.

Request format

Create a ticket

This informations must be set in the body of the request via GET

{
	"token": "xxxxxxxx",
	"subject": "The subject of the ticket",
	"description": "This is the description of the Ticket",
	"priority": "1 (Normal) or 2 (Hoch) or 3 (Dringend)",
	"email": "[email protected]"
}

API Url

https://yourdomain.com/api/public/tickets/create

Fetch all tickets per user (author of the ticket)

This informations must be set in the header of the request via GET

{
	"token": "xxxxxxxx",
	"email": "[email protected]"
}

API Url

https://yourdomain.com/api/public/tickets/fetch

---

License

MIT License

Copyright (c) 2019 Omar De-Giuli & Thomas Adamek

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.