janczur / przypomijankabackend

Backend API for application

Przypomijanka - Backend API

Application for sending reminders to users
See Design View to learn about the processes and understand how the system works

Table of Contents

• Built With
• Getting Started
  • Installation
  • Testing
  • Dummy data
• Development
• Api Documentation
• Contact

Built With

• Symfony 5.2

Getting Started

To install the application you will need:

• PHP >= 7.4
• git
• composer
• symfony flex

Installation

1. Go to the folder where you want to create the project and clone the repository

git clone https://github.com/Janczur/PrzypomijankaBackend.git

2. Install dependencies

composer install

3. Configure environment
   Information about configuring environment
   copy ".env" file to ".env.local.dev" and provide valid DSN configuration

DATABASE_URL="mysql://db_user:[email protected]:3306/db_name"
MESSENGER_TRANSPORT_DSN=doctrine://default
MAILER_DSN=smtp://user:[email protected]:port
MAIL_FROM=[email protected]
ADMIN_MAIL=[email protected]

Testing

For tests run in the main project directory

php bin/phpunit

Dummy data

If you want to populate database with dummy data run:

php bin/console doctrine:fixtures:load

Development

To start local server type in your project directory

symfony serve

Api Documentation

Coming soon

Contact

Jan Przybysz - [email protected]