Scrum Pocker Api Project

An awesome README file to jumpstart your projects!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This API project build for a real time scrum poker application.

• You can create a user
• You can use without registration
• You can list the rooms
• You can join the room
• You can create a room
• You can rate
• You can see the room detail

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• .net core 6

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Visual Studio
• Docker
• npm

  npm install npm@latest -g

• Postman

Installation

1. Clone the repo

   git clone https://github.com/adildeveci/ScrumPocker.git

2. Build

   dotnet build

3. Run

   dotnet run

(back to top)

Usage

You can use postman for api call. Or you can send a request directly SwaggerUI.

• Firs create a ClientToken

• Create an user token for room and other process with client token

• Save user token with other request, and use it until expires

• If user token was expired then you can generate a new user token with refresh token

• You can create a room with an user token.

• Some method requires a user token. Some method working with client token. But you can call all method with user token.

(back to top)

Roadmap

• Generate Api Project
  • Use Swagger
  • Use BaseReponse model
  • Handle exception to BaseResponse
  • Handle validation exception to BaseRepsonse
  • Auth methods
  • Role based auth
• SignalR Hub methods
• Db entegrations
• CI/CD pipelines
• UI integration
  • Web
  • Mobile

See the open issues for a full list of proposed features (and known).

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Adil Deveci - LinkedIn - adildeveci@hotmail.com

Project Link: https://github.com/adildeveci/ScrumPocker

(back to top)

Acknowledgments

• Udemy
• Fatih Çakıroğlu

(back to top)