-
Notifications
You must be signed in to change notification settings - Fork 0
DTH Wiki
4.1 Dashboard
4.2 Users
4.2.1 Edit
4.2.2 Show
4.2.3 Delete
4.3 Live
4.3.1 Edit
4.3.2 Show
4.3.3 Delete
4.4 Events
4.4 Groups
4.4.1 Edit
4.4.2 Show
4.4.3 Delete
4.5 Podcasts
4.5.1 Show
4.6 Library
4.7 Schedule
4.8 Custom Settings
DTH is a social network based on something with some objective. 😬
Ruby v2.7.4
Rails v6.1.4
Mysql2 v0.5.3
First, is necessary to clone the project from the main branch: git clone [email protected]:sygnalgroup/dth-api.git
After clone, go to the project folder and run bundle and then yarn commands to install all gems of the project.
Run `rails db:create to create the project database.
Run rails db:migrate to apply all Schema alterations.
To use this project properly is necessary to replace the credential files inside the project. Ask an administrator for the updated credential files, then go to the project folder Config > Credentials and replace the files. With the system console, run EDITOR=nano rails credentials:edit --environment development command to edit YOUR database information access (username and password).
On the terminal, run rails s, and in another terminal tab run ./bin/webpack-dev-server and the system should be able to be used at any navigator with the link http://localhost:3000/. Another way to execute this project is by running foreman start -f Procfile.dev, then will not be necessary to use two different terminals.
4.1 Dashboard tab: TBD
4.2 Users
Users tab: List all persons registered on the system, showing what kind of users they are: if it is a student or a coach, email, phone, and how many following and followers they have. Yet in the same place, three buttons are available: Edit, Show and Delete.
Yet on the user's tab, are available 2 other buttons: New user and All Users.
The New user button will open a screen to register a fresh new user with all information.
All Users button will serve to show only Coach, only student, or all users, depending on what option is selected.
4.2.1 Edit
This button will open a screen where can be edited user info like First name, Last name, Phone, Email, if this user is a coach or not by checking or unchecking the "Coach" box and the profile photo by clicking on "Search" button and uploading a new image. Location info can be edited, like Street, City, State, and Zip code. All the Social Network Info can be edited too: Tiktok, Instagram, Business name, and Bio.
At the end of this page, two buttons are available: Save and Back to the User list.
The Save button will save all the alterations made.
The Back to User list will take you back to the previous page (User list).
4.2.1 Show
This button will open a screen that shows all user information like Name, Email, Coach, Phone, Business Name, Instagram, TikTok, Street, City, State, Zip code, number of Following, and Followers. If the User is a Coach, will be available a button to add New Students for him, and if the user is a Student, will be available a button to add New Coaches.
4.2.2 Delete
This button will delete the user. When clicking on it, a new window will show up, asking if you really want to delete the user, because this action is irreversible. After being deleted, the user cannot be restored.
4.3 Events tab:
This tab will show all events created by a Coach. Will be displayed: created at, title, description, start date, end date, and ads.
Will be available to a button named New event, to create a fresh new event.
4.3.1 Edit
On this tab, will be possible to edit all the information registered when the event was created.
The save button will save all the alterations made.
The back to User list will take you back to the previous page (User list).
4.3.2 Show
This button will open a screen that shows all event information like when it was created, Title, Description, Start date, End date, and Time zone of the event. Yet on this page, a New Registration button is available to add users to the event. When clicking on it, a new window will show a list of users who can be registered by clicking on Add button.
4.3.3 Delete
This button will delete the event. When clicking on it, a new window will show up, asking if you really want to delete the event, because this action is irreversible. After being deleted, the event cannot be restored.
4.4 Groups tab:
This tab will show all groups created. A button named New Group is available to create a fresh new group. For each group listed, will be a button to Edit, Show and Delete the group.
The New Group button will show a page to put the Name of the group, if it is an active group (if you mark the checkbox, it will be active), and can be chosen image for this group by clicking on Choose from Gallery button. The Save button will save all information and the Back to group list will send you back to the group list page.
4.4.1 Edit tab:
On this tab, it will be possible to edit all the information registered when the group was created.
The Save button will save all the alterations made.
Back to the group list will take you back to the previous page (Group list).
4.4.2 Show tab:
This button will open a screen that shows all event information like an ID when it was created and the name of the group.
Yet on this page, a New user button will be available to add new members to this group.
The Save button will save all the alterations made.
The Back to Group list will take you back to the previous page (Show Group).
Underneath the group information, you will see a list of the user who is inside this group. For each user is available a button to Delete the user of the group. When clicking it, a new window will show up, asking if you really want to delete the user, because this action is irreversible. You can add the user again after this action.
4.4.3 Delete tab:
This button will delete the group. When clicking on it, a new window will show up, asking if you really want to delete the group, because this action is irreversible. After being deleted, the group cannot be restored.
4.5 Podcast tab:
This tab will show a list of all podcasts created. Available a button named Refresh, to update the podcast list.
4.5.1 Show tab:
For each podcast listed, is available a button to show all information about the podcast like Buzzsprout ID (Buzzsprout is a host for podcasts, and the ID is an identifier for the account used), Description, Summary, Artist, Publish date, when it was inactivated, Custom URL (a custom link published by the owner/artist of the podcast), Tags, Duration, Episode number, Season Number, if it's explicit or not, if it's private or not and Total Plays of this podcast.
4.6 Library tab:
On this tab, all users can upload and use all images and videos available. Inside this tab, another three new tabs are available: Upload, Images, and Videos. In the Upload tab, can be uploaded images and videos when click on Choose file button.
4.7 Schedule tab:
On this tab, with an Acuity account is possible to manage a schedule for a podcast. To connect your account is available a button named Connect to Acuity, then you will be redirected to a website login and when the account is connected, you will be redirected back to the DTH Schedule page to manage the schedule. Each user has their own acuity account, where all specific configurations can be done.
There are some options on this tab after login in with Acuity. Appointment type lets you choose with a schedule that will be used (with will previously configured on acuity account), Date - where is chosen manually the day that will be managed and a button named View Times to show what is available or not for the day chosen.
Underneath the Appointment type area, will be shown a table with two buttons, on the left side is a button showing the previous day and on the de right day is a button showing the next day based on the date chosen in the Appointment type date. In the middle of these two buttons, will be seen the date chosen previously.
For more information about how to use Acuity, check the official documentation on this link.
4.8 Custom Settings tab:
TBD
For now, when a group was tagged with inactive, there is no way to (a user) restore him back.
TBD
TBD
Rascunho de documentação