Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ayfri/pokestore
PokeStore is a website that allows you to check Pokemon cards.
https://github.com/ayfri/pokestore
astro-js pokemon pokemon-cards website
Last synced: 27 days ago
JSON representation
PokeStore is a website that allows you to check Pokemon cards.
- Host: GitHub
- URL: https://github.com/ayfri/pokestore
- Owner: Ayfri
- License: gpl-3.0
- Created: 2023-10-02T10:00:36.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-08-27T21:01:04.000Z (2 months ago)
- Last Synced: 2024-08-28T02:14:41.782Z (2 months ago)
- Topics: astro-js, pokemon, pokemon-cards, website
- Language: Astro
- Homepage: https://pokestore.ayfri.com
- Size: 4.59 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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 :
1. Clone the project
2. Install the dependencies (`npm install`)
3. Create a MariaDB database and import the `dump.sql` file.
4. 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](https://pokemontcg.io/).
5. 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).
6. Run `prisma generate` to generate the Prisma client.
7. Run the api with `npm run api`.
8. Run the client with `npm run dev`.
9. 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.
10. 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 :
```shell
/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.