FlexSpot Fantasy Community

Website for FlexSpot Fantasy Community.
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. Acknowledgements

About The Project

This is the website for the FlexSpot Fantasy Football community.

Built With

• Fastify
• MikroORM
• NextJS

Getting Started

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

Prerequisites

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.

Installation

1. Clone the repo

   git clone https://github.com/chrisparsons83/flexspotff.com.git

2. 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

3. Run the database. You can get a sql dump and put it in .db-load before running.

   docker-compose -d up

4. 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
5. If you want to start from a clean database, you can run migrate:up using Mikro ORM.

   cd backend
   npx mikro-orm migration:up

6. To run the front end website:

   cd frontend && npm run dev

Usage

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.

Roadmap

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

Contributing

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.

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

License

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

Contact

Chris Parsons - Personal Website

Project Link: https://github.com/chrisparsons83/flexspotff.com