PokeStore

PokeStore is a website that allows you to buy Pokemon cards. It is a school project. You can search for cards, add them to your cart and buy them.

Installation

To install the project you need to follow multiple steps :

Clone the project
Install the dependencies (npm install)
Create a MariaDB database and import the dump.sql file.
Create a .env file in the api folder of the project and fill it with the following variables :
- DATABASE_URL: The URL of your MariaDB database.
- POKEMON_TCG_API_KEY: The API key of the Pokemon TCG API.
Create a .env file in the root folder of the project and fill it with the following variables :
- API_URL: The URL of the API.
- API_KEY: The API key of the Google Maps API (you must activate the "Places API" on the key).
Run prisma generate to generate the Prisma client.
Run the api with npm run api.
Run the client with npm run dev.
Go to http://localhost:4321/admin/load and wait for the 'ok' to appear to load the JSON data into the database. This step can take a few dozen seconds.
Go to http://localhost:4322 and enjoy the project !

Technologies

This project uses the following technologies :

Astro.js for the client and the api
MariaDB for the database
Node.js for running the modules
NPM for the dependencies
Typescript for the typing and the main code
Vite for the bundling

Dependencies

This project uses the following dependencies :

@astrojs/node for the server-side rendering
@prisma/client for the database
@types/google.maps for the Google Maps API
astro for the client-side rendering
pokemontcgsdk for the Pokemon TCG API
prisma for managing the database

Project structure

The project is structured as follows :

/api : The main folder of the api
  /prisma : The prisma configuration
  /resources : The scripts and JSON files used to load the database
  /src : The source code of the api
    /pages : The endpoints of the api
      
/public : The public folder of the client
/src : The source code of the client
  /components : The components of the website
  /fonts : The fonts of the website
  /pages : The pages of the website
  /styles : The styles of the website
  /utils : The utilities of the client

Database

The database is structured as follows :

API

The API structure can be found in the /pokestore-spec.yaml file.

License

This project is licensed under the GNU GPLv3 license. You can find the license in the LICENSE file.

Ayfri/pokestore