Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
navotera authored Aug 19, 2023
1 parent 7f1048e commit f80a337
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Leconfe - Conference Management System

Leconfe is an open-source conference management system that allows users to manage conferences, papers, and reviews.
Leconfe is an open-source conference management system that allows users to manage conferences, papers, reviews, including publishing the issue.
This project is created to make the conference management seamless including the management of the participant, venue, registration, payment, and the crucial aspect of the conference event.

[Leconfe](https://openjournaltheme.com) is a [Open Journal Theme](https://openjournalteam.com) product.

Expand All @@ -14,7 +15,7 @@ WIP

## Requirements ⚙️

Leconfe is a regular Laravel application, so it can be installed on any server that meets the [Laravel server requirements](https://laravel.com/docs/10.x/deployment#server-requirements).
Leconfe is a regular Laravel application that can be installed on any server that meets the [Laravel server requirements](https://laravel.com/docs/10.x/deployment#server-requirements).

## Local development 💻

Expand All @@ -24,13 +25,13 @@ WIP

Thank you for considering contributing to Leconfe! Here are some guidelines to help you get started:

### Structure and Maintanability
### Structure and Maintainability

- Avoid adding new dependencies unless absolutely necessary.
- Use the `__()` helper function instead of hardcoding translations.
- Each Eloquent model should have a sensible [Database Factory](https://laravel.com/docs/10.x/database-testing#factories).
- Use [Queued Jobs](https://laravel.com/docs/10.x/queues) to perform long-running tasks. Notify users that a task is running.
- Use [Notifications](https://laravel.com/docs/10.x/notifications) to send emails to users, or a [Mailable](https://laravel.com/docs/10.x/mail) when it's unimaginable that a notification would be sent to anything other than the mail channel.
- Use [Notifications](https://laravel.com/docs/10.x/notifications) to send emails to users, or a [Mailable](https://laravel.com/docs/10.x/mail) when it's unimaginable that a notification would be sent to anything other than the main channel.
- Prefer enums over constants.

### Security and Performance
Expand All @@ -46,7 +47,7 @@ Thank you for considering contributing to Leconfe! Here are some guidelines to h

## Security Vulnerabilities

If you discover a security vulnerability within Leconfe, please send an e-mail to Leconfe via [rahmanramsi19@gmail.com](mailto:rahmanramsi19@gmail.com). All security vulnerabilities will be promptly addressed.
If you discover a security vulnerability within Leconfe, please e-mail Leconfe via [support@openjournaltheme.com](mailto:support@openjournaltheme.com). All security vulnerabilities will be promptly addressed.

## Credits

Expand Down

0 comments on commit f80a337

Please sign in to comment.