Shelter brain

Web app, which manages animals' shelter.

Features:

• Adding animals by shelter's workers
• Deleting animals by workers
• Generating shelter reports
• Fetching shelter reports in pdf and csv formats
• Registration and logging in as worker
• Automatically sending email warning to workers about shelter state if there is <= 50% of free space
• Storing images of animals
• Storing profile photos of workers
• Deployment on heroku
• Mobile app which displays shelter's report (React Native)
• Web app which makes use of all backend's features

Tech stack

The most important technologies:

1. Java (8+)
2. JavaScript (ES6+)
3. Spring (MVC, Data JPA, Boot, Mail)
4. Hibernate
5. React (with create-react-app)
6. Lombok
7. Maven
8. PostgreSQL
9. H2
10. OpenPDF
11. Apache Commons CSV
12. JWT Java library
13. yarn
14. axios
15. Bootstrap 4 (and reactstrap)
16. HTML5
17. React Router
18. React Native
19. Heroku
20. Git (hosted on GitHub)

TODO List

---

Developer's info

Frontend and backend are totally separeted (unique directories and code bases)

Running backend:
    Run main() method of ShelterBrainBackendApplication class.

Running frontend:
    Enter frontend directory and call 'yarn start'.

Running mobile app:
    Enter mobile_app directory and call 'yarn start'. Now scan QR code which you can find at new browser card generated by Expo.

Deployment

You can deploy application (backend) on heroku.

    heroku login  
                        cd backend  
                        heroku create  
                        git add .
                        git commit -m "."  
                        git push heroku master  
                        heroku addons:create heroku-postgresql
                    

    In backend directory we have second - nested git repository, because heroku needs it - this repository is only local, without connected remote.
    Database URI is in heroku config. You must copy&paste it to application.properties.
    Now swap the backend URL at frontend side in Config.js file.
    heroku logs --tail - displaying backend's logs in real time

Updating an existing backend instance on heroku:

    cd backend  
                        git add .  
                        git commit -m "."  
                        git push heroku master
                    

        If you have whole application connected to some git repository

    cd ..  
                        git add .  
                        git commit -m "changes description"  
                        git push origin master
                    

FileCloud

The multi-user web application for uploading and managing files stored on remote cloud

At localhost:8080 in web browser you can access web client of FileCloud.

Features

• User authorization system
• Web client
• Variety of file operations (add, get, remove, compress, etc.)
• Data validation that ensures its consistency

Developers info

• Unit and integration tests (backend) are provided.
• Authorization is done by session cookies with Spring Security roles. There is only one admin and many users.
• Files are paged (pages start from 1).
• As database, we are currently using H2 in-memory database.
• Passwords are encrypted using BCrypt.
• You can log in as administrator using: gjm_admin and admin credentials. This will give you access to panel where you can see other registered users.
• Web client was created using jQuery, Bootstrap and Thymeleaf (with Spring Security module).

Technologies used

• Java
• Spring
• Hibernate (JPA)
• JUnit
• Mockito
• Maven
• Thymeleaf
• Lombok
• HTML
• CSS
• JavaScript
• jQuery
• Bootstrap
• Axios

Each user has these fields:

• id
• username - is unique and required
• password - is required, encrypted via BCrypt
• active - always true, currently unused
• roles - list of user roles (ROLE_ADMIN or ROLE_USER)
• files - list of user files

Operations on users:

• POST /register - register user. User must be sent via HTML form.
• GET /login - login user by name and password (sent via HTML form) - generated by Spring Security

Each file has these fields:

• id
• name - is unique (per user) and required
• type - MIME file type, required
• bytes - file content as byte array, required
• owner - owner of file (User object)

Operations on files:

• POST /api/files secure - add a new file. File must be sent via HTML form with type="file". In successful case 201 is returned. If file already exists, 406 will be returned.
• GET /api/files secure - returns requested file by name (passed via query string) or 404 status code if file does not exist.
• DELETE /api/files secure - deletes file by name (passed via params) or 404 if file does not exist.
• GET /api/files/names - returns list of all file names
• GET /api/files/count - returns files count
• GET /api/files/zip - returns compressed all files in ZIP format
• GET /api/files/names/paged - returns requested page of file names (page number is passed via query string)
• GET /api/files/paging - returns pages count

Web Quiz

The multi-user web application for creating and solving quizzes.

Features

• User authorization system
• Variety of quiz operations (add, remove, solve, get)
• Data validation that ensures its consistency

Developers info

• Unit and integration tests are provided.
• Authorization is done with JWT strategy (you pass JWT inside Authorization header). If you will be unauthorized at the secure route, 401 status code is returned.
• Quizzes are paged (pages count from 0).
• There are two implementations of QuizService (choose implementation in QuizController's constructor):
  • QuizServiceDatabaseImpl (DatabaseQuizService qualifier) - stores quizzes data inside database
  • QuizServiceInMemoryImpl (InMemoryQuizService qualifier) - stores quizzes data inside in-memory list

Technologies used

• Java
• Spring
• Hibernate (JPA)
• JUnit
• Mockito
• Gradle
• Git

Each user has these fields:

• id
• username - is unique and required
• password - at least 5 characters, encrypted via BCrypt
• email - is required and must be valid email

Operations on users:

• POST /api/register - register user. User's JSON must be sent in request body. When success returns 200, but when user already exist 400 is returned.
• POST /api/login - login user by name and password (sent in request body). JWT token is returned in case of success (200). When user doesn't exist 404 is returned and when passwords are mismatched 400 will be returned.

Each quiz has these fields:

• id
• title - is required
• text - content (question) of a quiz, required
• options - list of possible answers, required at least 2 options
• answer - indexes of correct answers, only writable (Jackson doesn't serialize it), optional (because all options can be wrong)

Operations on quizzes:

• GET /api/quizzes/{id} secure - returns Quiz JSON or 404 if quiz with such ID doesn't exist
• GET /api/quizzes?page=PAGE secure - returns requested page of quizzes
• POST /api/quizzes secure - adds a new quiz (passed via request body). In response body there will be resent added quiz with fulfilled ID field.
• POST /api/quizzes/{id}/solve secure - solves an existing quiz by ID. In request body you must pass answer list fulfilled with indexes of user answers. This list can be empty, because some quizzes can have no correct answers. 404 will be returned if requested quiz doesn't exist and 200 in other cases. In response body there will be success and feedback keys, for example:

    {
                    "success": "true",
                    "feedback": "Congratulations, you're right!"
                }
              

• DELETE /api/quizzes/{id} secure - deletes an existing quiz by ID. When quiz doesn't exist, it returns 404 and 204 in successful case.