Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use poetry as dependency manager #148

Closed
wants to merge 4 commits into from
Closed

Use poetry as dependency manager #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9fe51e3
style: remove the extra space to the right of like container (#128)
MagneticNeedle Oct 17, 2022
ed01d23
feat: add tags to exp when validating (#145)
MagneticNeedle Nov 12, 2022
de7b338
feat: add poetry config files
MagneticNeedle Nov 17, 2022
b877a7b
chore: add readme file for poetry
MagneticNeedle Nov 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions bfportal/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<p align="center">
<img width="300" src="https://raw.githubusercontent.com/battlefield-portal-community/Image-CDN/main/bf_portal_logo_bc.png#gh-dark-mode-only">
<img width="300" src="https://raw.githubusercontent.com/battlefield-portal-community/Image-CDN/main/bf_portal_logo_noir.png#gh-light-mode-only">
</p>

[![Docker Build](https://github.com/battlefield-portal-community/bfportal.gg/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/battlefield-portal-community/bfportal.gg/actions/workflows/main.yml)
# What is this ?

With the release of battlefield 2042, ripple effect studio, added the ability to make custom game modes called "experiences", currently there is no way to share a game mode outside of the game, this project aims to fill that gap.
This project will replace the current website at https://bfportal.gg/

# Info
Head over to [bfportal.gg](https://bfportal.gg/), and try it out

## Features
- User system (Discord login for integration with portal community discord server)
- Auto Fill API for forms
- Pagination and website wide search

## How it works
It is pretty straight forward

- You use your discord account to make a new account on the website and submit your experiences.
- On the submission page if u choose to share the playground Url of the experience, the submission form will autofill 😃.

You can later edit your experience if u like.

## How to run locally
<details>

<summary>
Click to show !!!
</summary>

- create and activate a venv
- install dependencies `python -m pip install -r requirements.txt`
- copy the [.env.template](bfportal/.env.template) file and rename it to .env
- fill the appropriate data in .env file
- Do first run migrate
- run `python manage.py ensure_superuser --username bfportal --email [email protected] --password <password>`
- run `python manage.py ensure_initialization`
- run server with `python manage.py runserver`
- login via discord to create a new user
- run command `python manage.py fake --generate 50` to create a few fake pages
- reload admin now u should and a data to explore

</details>


### Special Thanks to
- [gametools.network](https://gametools.network/) for providing API to autofill submisson form 🥰
- [Wagtail](https://github.com/wagtail/wagtail) for providing an awesome framework that makes managing submissions very easy ✅
- [tailwindcss](https://github.com/tailwindlabs/tailwindcss) for saving the lives of backend developers. 🙏
- [Matavatar](https://discord.com/users/236802771381125120) from BFportal discord community for designing UI of the website 🤝
Loading