Goassign.me

Responsive REST web application created by using Javascript-CSS-HTML to manage users' notes.
The application passed w3c HTML and CSS validation.

Table of Contents 📃

1. About 🤔
   • Built With
2. Getting started 🚀
   • Prerequisites
   • Installation
3. How does it work 📔
4. Visualization 📷 with a guide 📙
5. Contributing ❤️
6. License 📝
7. Contact ☎

About 🤔

Application is the final result of the project to pass Information Technology classes at my university 🎓. This was created entirely by me 😁 based a little on a tutorial provided for the project. While making the app, I was trying to think about future users 👥 and how to provide them easy, clean and comfortable experience.

Built With

• JavaScript, CSS, HTML
• Mysql2 and Docker

Getting started 🚀

Prerequisites

• Git
  • Follow the guide

    https://github.com/git-guides/install-git

• Node.JS and Express.JS
  • Packages should be installed automatically, but in case they don't install nugget package manager and following packages:
    • bcryptjs
    • cookie-parser
    • dotenv
    • ejs
    • express
    • express-session
    • i18n
    • mysql2
    • sequelize
• Docker

Installation

1. Use your command line and clone the repository:

 git clone https://github.com/iamxdave/goassign.me.git

2. Go to the clonned folder:

cd goassign.me

3. Install packages

npm -i

4. Open the repository in any development environment
   
5. Create database schema in phpmyadmin localhost:8183 using the script in

/db/sequalize/config/schema

or copy it from below

CREATE SCHEMA IF NOT EXISTS `goassign-me`;

Important! Login and password for the admin panel you can find in .env file

6. Enter db folder and run docker in terminal

cd db

docker-compose up

7. Run application in terminal

npm run start

How does it work 📔

The application allows logged users to make notes and update existing ones in order to track their implementation progress. It also always logged users to make accounts for new users to share them filled with notes board. All passwords are hashed with bcrypt package and all data is restricted only for logged users. Also there are two implemented languages to choose from: PL and EN.

Visualization 📷 with a guide 📙

The application has only one page on which website redirect the user on start.

List of existing users and actions to their data

Details of the first user and his permissions for the notes

I recorded a short gifs to represent how the app works in a practise.

A short gif of the main page, logging in and changing app language.

A short gif of basic app interactions and updating a note.

Contributing ❤️

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

License 📝

Copyright 2022 iamxdave

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Contact ☎

dawidwrobelx@gmail.com

Project Link: https://github.com/iamxdave/goassign.me