https://github.com/mwafrika/kevent-documentation

https://github.com/mwafrika/kevent-documentation

Last synced: 2 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/mwafrika/kevent-documentation
• Owner: mwafrika
• License: mit
• Created: 2022-06-24T16:28:59.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-01-02T14:23:24.000Z (almost 2 years ago)
• Last Synced: 2023-03-04T01:56:36.431Z (over 1 year ago)
• Size: 19.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Kevent-documentation

## Description

> Kevent is a full-stack tourism software that helps you find the best places to visit in your area based on your preferences.

## Built With

- TypeScript

- React

- Express

- Redux

- TailwindCSS

- TypeORM

- Postgres

## API Documentation

[API Dcumentation with postman](https://documenter.getpostman.com/view/6127109/UzBqq5mr). This project's APIs are all hosted on [Heroku](https://kevent-rdc.herokuapp.com), and the documentation is created using Postman.

### [Live Demo](https://www.kevent-rdc.com/)

## Getting Started

To test the Kevent application you need the following information:

### 1. Login as administrator:

   

   - email: [email protected]

   - password: admin

  

 ### 2. Login as a user:

   

   - email: [email protected]

   - password: 123456

## Access management:

### 1. Admin

- The administrator has complete access to the system, which means he may do whatever he wants with it such as.

  - Perform a CRUD action on Packages.

  - Perform a CRUD action on Expeditions.

  - Perform a CRUD action on Places(Locations)

  - Change the user role

  - Remove a user from the system.

### 1. User

- The user has limited access to the system, which means he can:

  - Make reservations for expeditions and packages.

  - Get all reservations that belong to him

  - Delete reservations that belong to him

  - Edit reservations that belong to him

  - Get all the available packages and expeditions but he can do any action

## Additional features

   - Password reset is available to all registered users.

   - Without logging in, any user on the system can contact the system administrator directly about a specific package or expedition by filling out a form with the appropriate details.

## Need to see the code base ?

For some reason, the source code for this project is private; if you are interested in seeing it, please contact me via any of the methods listed below.

## Author

👤 **Mwafrika Josue**

- GitHub: [@mwafrika](https://github.com/mwafrika)

- Twitter: [@mwafrika](@mwafrikamufung1)

- LinkedIn: [Mwafrika Mufungizi](https://www.linkedin.com/in/mwafrika-mufungizi/)

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgements

- Thanks to everyone who will get time to check this project especially to recruiters.

## 📝 License

This project is [MIT](./MIT.md) licensed.