Website for FlexSpot Fantasy Community.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
This is the website for the FlexSpot Fantasy Football community.
To get a local copy up and running follow these simple steps.
This is an example of how to list things you need to use the software and how to install them.
- npm
npm install npm@latest -g
- Optional: docker and docker-compose.
- Clone the repo
git clone https://github.com/chrisparsons83/flexspotff.com.git
- Switch to working directory, and install NPM packages for both frontend and backend. (This probably should be wrapped in an npm script)
npm install npm run install:frontend npm run install:backend
- Run the database. You can get a sql dump and put it in .db-load before running.
docker-compose -d up
- Set your environmental variables. For dev, you'll likely just want to use the .env setup.
cp ./backend/.env.sample ./backend/.env
- Update the following variables when you make this copy:
- DISCORD_CLIENT_ID
- DISCORD_CLIENT_SECRET
- FASTIFY_COOKIE_KEY: any random string
- JWT_KEY: any other random string
- Update the following variables when you make this copy:
- If you want to start from a clean database, you can run migrate:up using Mikro ORM.
cd backend npx mikro-orm migration:up
- To run the front end website:
cd frontend && npm run dev
TODO: Update this copy.
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
Changes to the database schema are done via MikroORM Migrations.
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE
for more information.
Chris Parsons - Personal Website
Project Link: https://github.com/chrisparsons83/flexspotff.com