search

YCPRadioTelescope / RT-Contracts

Back-end architecture for the Radio Telescope Senior Software Design Project for the 2018-2019 academic year
3 stars 1 forks source link

readme

RT-Contracts

Web-Application Back-End Server for YCAS Radio Telescope

GitHub Repository

Website URL: https://github.com/YCPRadioTelescope/RT-Contracts

Clone command (https): git clone https://github.com/YCPRadioTelescope/RT-Contracts

Clone command (git): git@github.com:YCPRadioTelescope/RT-Contracts

Repository Owner

Name: YCPRadioTelescope

GitHub Account: https://github.com/YCPRadioTelescope

Email Address: jhorne@ycp.edu

Amazon Web Services Account Owner

Name: Joel Horne

Email Address: jhorne@ycp.edu

Installation

The following technologies are used in the development of the back-end application:

GitHub Repository Setup

You can clone the repository using either the https or the git commands supplied above, but in order to contribute to the repository, you must be added as a contributor. To achieve this, contact the repository owner (mentioned above), and they will handle this.

IntelliJ IDEA Setup

IntelliJ IDEA Ultimate Edition is free for anyone with a student license, which thankfully, applies to anyone with an ".edu" email address. All you need to do is create an account on their website, and from there, you can access all software that applies to you via the student license. It is important to note that the student license can only be used for student projects, which this project falls under.

Windows Setup

The process on windows is rather straightforward, and is primarily handled through an installer/setup wizard.

Linux Setup

The steps needed to install via Linux are as follows:

  1. Download the latest version IntelliJ IDEA Ultimate Edition
  2. Extract the tar file using (tar -xvf )
  3. Move the newly extracted folder to the /opt folder (sudo mv /opt/)
  4. Go to the folder location in the opt folder (cd /opt/)
  5. Go inside of the IntelliJ IDEA bin folder (cd bin)
  6. Run the idea.sh script. This will run the initial setup for IntelliJ IDEA (./idea.sh)
  7. You will then be prompted by IntelliJ to enter some user-specific preferences for IntelliJ IDEA.
  8. After choosing your preferences, verify your installation using your JetBrains account

Mac Setup

  1. Download the disk image (DMG)
  2. Mount the disk image and follow the installation instructions

Gradle Setup

Windows Setup

For Windows users, you should be able to follow the steps here to install Gradle.

Mac and Linux Setup

If you are using Mac or Linux, it is highly recommended to install SDKMAN, which allows you to then easily install Gradle using SDKMAN. The list of steps to install Gradle on Mac and Linux are:

  1. Install SDKMAN (curl -s “https://get.sdkman.io” | bash)
  2. Initialize SDKMAN (source "$HOME/.sdkman/bin/sdkman-init.sh")
  3. Verify the installation was a success (sdk version)
  4. Use SDKMAN to install Gradle (sdk install gradle)
    1. Note: This will install the most recent version
    2. To install a specific version, supply the version (sdk install gradle 4.7)
  5. Verify the installation was a success (gradle -v)

Install MySQL

Windows Setup

For Windows users, you should be able to follow the steps/setup wizard here

Linux Setup

If you are using linux, do the following:

  1. Update package lists (sudo apt-get update)
  2. Install MySQL Server (sudo apt-get install mysql-server)
  3. Start MySQL Server (sudo systemctl start mysql) or (sudo systemctl start mysqld) depending on your linux distro
  4. Secure the installation (sudo mysql_secure_installation). This will have you enter the root username and password Verify your credentials (mysql -u root -p). This will prompt you to enter the password you entered in step 4.

Mac Setup

  1. Download disk image (DMG) from dev.mysql.com/downloads/mysql/
  2. Mount the disk image and follow the installer instructions
  3. In the terminal, change the directory to the MySQL folder (cd /usr/local/mysql)
  4. Run the secure installation (sudo bin/mysql_secure_installation) and follow the setup
  5. To start running MySQL, open your Mac's System Preferences and open the application near the bottom of the window. There will be a button to start the server.

Initialize Database in IntelliJ

IntelliJ has a built-in database tab that allows you to manage the contents of your database from within the IDE. In order to add your localhost database to IntelliJ, do the following:

  1. Open Database Tab in IntelliJ. In most cases, this is located on the right-hand side of the screen. On some Linux distributions, you may need to manually access it through View -> Tool Windows -> Database.
  2. Add radio_telescope schema to MySQL using create database radio_telescope
  3. Edit the line in build.gradle def profile = (project.hasProperty('profile') ? project.profile : 'prod').toLowerCase() to def profile = (project.hasProperty('profile') ? project.profile : 'local').toLowerCase() to setup the database on your local machine.
  4. Add New MySQL Datasource & Test Connection (using credentials used for MySQL installation) Note: specify the database url as the one found in the local application properties file
  5. If the connection works, you're good to go!

Properties Files

The application depends on certain application properties files that unfortunately cannot be added to GitHub. These files must be obtained from the repository owner. The properties files must be placed in

/RT-Contracts/src/main/resources/properties.

As well, to run the database locally you must add your local MySQL password to the spring.datasource.password field of the application_local.properties file.

Install Gradle Wrapper

In order to install the gradle wrapper (needed to boot up the application locally), issue the following command in the terminal inside of IntelliJ: gradle wrapper Then, boot the application with gradlew bootRun (./gradlew bootRun on Linux). This will populate the local database.

API Endpoints Documentation

The API endpoints and their respective form templates are hosted on SwaggerHub here. They will be updated as new endpoints are added.

Javadocs

The Radio Telescope Contracts/Back-End application uses javadocs to publish documentation. This process can be done manually via the following process:

  1. Publishing javadocs in kotlin is done via dokka
  2. In the build.gradle file, run the dokka task, or in the terminal run 'gradle dokka' to generate the documentation folder
  3. Take the contents of the 'docs' folder that was created and put it in the gh-pages branch
  4. NOTE: overwrite any existing files in the gh-pages branch with the contents of the newly generate docs folder
  5. Still on the gh-pages branch, add, commit, and push the changes and GitHub will handle the rest

Alternatively, if you cloned the repository via git/ssh, you can simply run the following command, which will automate the above process for you (recommended):

  1. Run the ./publish-api-docs.sh script

The docs can be viewed here. As a general rule of thumb, the docs should be published whenever code is merged into master and deployed to the production server.

Amazon Web Service Management Console

The management console for the web application (along with the services used for this project) can be accessed here.

In order to access the management console, you need an IAM User account. If you do not have one, contact the console root user (mentioned above) and they will create an IAM user for you and send you the credentials.

Useful Troubleshooting

Correct Versioning

For the backend, we use:

There is a lot going on with these files, and if something isn't working the problem most likely resides here. Important Things to check:

The backend may run into another issue with the bean creation:

"2022-10-12 11:29:00.140 ERROR 9340 --- [ost-startStop-1] o.s.b.web.embedded.tomcat.TomcatStarter : Error starting Tomcat context. Exception: org.springframework.beans.factory.BeanCreationException. Message: Error creating bean with name 'servletEndpointRegistrar' [...] "

- Suggested fix is to restart the computer since Tomcat is very moody