Notility App is a user-friendly application designed for efficient note-taking and collaboration. It allows multiple users to create, share, and collaboratively edit notes in real time.
- User Authentication
- Create, Edit, and Delete Notes
- Share Notes with Collaborative Editing
- Role-Based Access Control
- Responsive Design
- Docker
-
Clone the repository:
git clone https://github.com/kamdz01/WDPAI.git
-
Configure your database in
config.php. -
Run Docker Compose build:
docker-compose build
-
Start Docker Compose:
docker-compose start
-
Run Docker Compose:
docker-compose up
-
Use pgAdmin to import provided db.sql database structure.
-
Add user roles and note roles to the database.
-
Visit
http://localhost:8080in your web browser.
Create an account to start creating and sharing notes.
We warmly welcome contributions to the My Note App project! If you're interested in helping improve the app, here's how you can contribute:
If you find bugs or have suggestions for new features:
- Go to the Issues page of the project on GitHub.
- Check if the issue has already been reported.
- If not, click the
New Issuebutton. - Fill out the issue form with a detailed description of the bug or feature request.
If you'd like to contribute to the codebase:
- Fork the repository on GitHub.
- Clone your fork to your local machine.
- Create a new branch for your changes.
- Make your changes in the new branch.
- Commit your changes with clear, descriptive commit messages.
- Push the branch to your GitHub fork.
- Go to the GitHub page of the original project.
- Click the Compare & pull request button for your branch.
- Fill out the pull request form with a detailed description of your changes.
- Click Create Pull Request.
- Kamil Dziedzic - Initial Work - kamdz01
Distributed under the GNU Affero General Public License (AGPL) version 3.0.
Kamil Dziedzic - [email protected]