Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rudrakshi99/xharktank

This is backend for the application XharkTank, provides endpoints to pitch ideas to investors and to make counter-offers to entrepreneurs.
https://github.com/rudrakshi99/xharktank

backend crio django-rest-framework phonepe-tech-scholars-program python rest-api xharktank

Last synced: 10 days ago
JSON representation

This is backend for the application XharkTank, provides endpoints to pitch ideas to investors and to make counter-offers to entrepreneurs.

Host: GitHub
URL: https://github.com/rudrakshi99/xharktank
Owner: rudrakshi99
License: mit
Created: 2022-12-01T05:44:17.000Z (about 2 years ago)
Default Branch: master
Last Pushed: 2022-12-03T13:14:22.000Z (about 2 years ago)
Last Synced: 2024-11-22T05:34:11.680Z (2 months ago)
Topics: backend, crio, django-rest-framework, phonepe-tech-scholars-program, python, rest-api, xharktank
Language: Python
Homepage: http://xharktank.crio.do/pitches/?author=sonirudrakshi99&url=http%3A%2F%2Frudrakshijss.pythonanywhere.com
Size: 34.2 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: Readme.md
- License: LICENSE

Awesome Lists containing this project

README

# :shark: XharkTank

SharkTank is a panel of potential investors, termed as "Sharks", who listen to entrepreneurs pitch ideas for a business or product they wish to develop. These self-made multi-millionaires judge the business concepts and products pitched and then decide whether to invest their own money to help market and mentor each contestant.

## Product Flows

These are the mandatory product flows that are expected while building the backend for the XharkTank application

1. Entrepreneurs will post Pitch by providing these inputs

- Name of the entrepreneur posting the pitch
- Title of the pitch
- Business Idea for the Product they wish to develop
- Ask Expected Amount for investment
- Percentage of Equity to be diluted

2. Investors will view all the latest pitches posted to date

- If the entrepreneurs post a new pitch, that would also get listed.

3. Investors will make a counteroffer to the pitch by providing these inputs

- Unique Id of the Pitch made by the entrepreneur
- Name of the investor making a counteroffer
- Amount ready to invest in the idea
- Ask Percentage of Equity for a company

# Demo Video

## Technology Stack to be used:

[![Run in Postman](https://run.pstmn.io/button.svg)](https://documenter.getpostman.com/view/14143990/2s8Yt1rUoy)

- **Backend**: Django Rest Framework
- **IDE**: VS Code
- **API Testing & Documentation:** Postman
- **Version Control**: Git and GitHub
- **Database**: SQLite

## Important Links :

### Frontend
* [Entrepreneurs Link](http://xharktank.crio.do/pitches/?author=sonirudrakshi99&url=http%3A%2F%2Frudrakshijss.pythonanywhere.com)
* [Investor Link](http://xharktank.crio.do/invest/?author=sonirudrakshi99&url=http%3A%2F%2Frudrakshijss.pythonanywhere.com)

### Backend
* [Link](http://rudrakshijss.pythonanywhere.com/)

### Backend Setup Instructions

- Fork and Clone the repo using

```
$ git clone https://github.com/rudrakshi99/XharkTank.git
```

- Setup Virtual environment

```
$ python3 -m venv env
```

- Activate the virtual environment

```
$ source env/bin/activate
```

- Install dependencies using

```
$ pip3 install -r requirements.txt
```

- Make migrations using

```
$ python3 manage.py makemigrations
```

- Migrate Database

```
$ python3 manage.py migrate
```

- Create a superuser

```
$ python3 manage.py createsuperuser
```

- Run server using

```
$ python3 manage.py runserver
```

## Testing Instructions

- Install the dependencies
```
$ pip3 install -r assessment/requirements.txt
```
- run the basic tests
```
$ python3 -m pytest --pspec --disable-pytest-warnings assessment/main.py
```

# License :memo:

This project follows the [MIT License](https://choosealicense.com/licenses/mit/).

## If you liked the project don't forget to star 🌟 and fork 🍽 the project.

Made with ❤ by Rudrakshi

[![forthebadge](https://forthebadge.com/images/badges/uses-html.svg)](https://forthebadge.com)
[![forthebadge](https://forthebadge.com/images/badges/uses-css.svg)](https://forthebadge.com)
[![forthebadge](https://forthebadge.com/images/badges/made-with-javascript.svg)](https://forthebadge.com)
[![forthebadge](https://forthebadge.com/images/badges/made-with-python.svg)](https://forthebadge.com)
[![forthebadge](https://forthebadge.com/images/badges/uses-git.svg)](https://forthebadge.com)
[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com)