Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ghost-land/nx-missing
Missing content for NX Shop
https://github.com/ghost-land/nx-missing
flask flask-application flask-restful
Last synced: 3 months ago
JSON representation
Missing content for NX Shop
- Host: GitHub
- URL: https://github.com/ghost-land/nx-missing
- Owner: ghost-land
- License: gpl-3.0
- Created: 2024-08-19T14:30:54.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-11-03T12:25:05.000Z (3 months ago)
- Last Synced: 2024-11-03T13:22:44.436Z (3 months ago)
- Topics: flask, flask-application, flask-restful
- Language: Python
- Homepage: http://nx-missing.ghostland.at/
- Size: 238 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nx-missing
`nx-missing` is a project designed to display and manage missing titles, updates, and DLCs for the Nintendo Switch platform. The project uses Python scripts to generate JSON files containing information about missing content and uses HTML, CSS, and JavaScript to display and filter this information on a webpage.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Files](#files)
- [Contributing](#contributing)
- [License](#license)
- [Authors](#authors)
## Installation
To install and run the project locally, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/ghost-land/nx-missing.git
cd nx-missing
```
2. Install the necessary Python dependencies:
```bash
pip install -r requirements.txt
```
## Usage
To use the project, run the Python scripts to generate the JSON data files, then open `index.jinja` in your browser. The interface allows you to display and search missing titles, updates, and DLCs.
### Python Scripts
- **`check_titles.py`**: Checks for missing titles and generates `missing-titles.json`.
- **`check_updates.py`**: Checks for missing updates and generates `missing-updates.json`.
- **`check_dlcs.py`**: Checks for missing DLCs and generates `missing-dlcs.json`.
- **`list.py`**: Contains utility functions for managing lists of content.
- **`main.py`**: Main script to run the checks and generate all necessary JSON files.
- **`run.py`** and **`update_data.py`**: Scripts to update and manage the data.
### JavaScript Scripts
- **`showTables.js`**: Handles the display of different data tables based on the selected tab.
- **`searchBar.js`**: Allows searching within the displayed tables based on user input.
### Data Files
- **`missing-titles.json`**: Contains information on missing titles.
- **`missing-updates.json`**: Contains information on missing updates.
- **`missing-old-updates.json`**: Contains information on missing old updates.
- **`missing-dlcs.json`**: Contains information on missing DLCs.
## Files
- **HTML/Jinja**: `index.jinja`
- **CSS**: `style.css`
- **JavaScript**: `showTables.js`, `searchBar.js`
- **Python**: `check_titles.py`, `check_updates.py`, `check_dlcs.py`, `list.py`, `main.py`, `run.py`, `update_data.py`
- **JSON**: `missing-titles.json`, `missing-updates.json`, `missing-old-updates.json`, `missing-dlcs.json`
### Key Features
1. **Automated JSON Generation**: Python scripts automate the process of checking and generating JSON files for missing content.
2. **Dynamic Table Display**: JavaScript functions handle the dynamic display of data tables.
3. **Search Functionality**: Users can search within tables to quickly find specific data.
4. **Data Management**: Uses JSON files to manage and store information about missing updates, titles, and DLCs.
## Contributing
Contributions are welcome! To contribute, please follow these steps:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature/NewFeature`).
3. Commit your changes (`git commit -am 'Add new feature'`).
4. Push to the branch (`git push origin feature/NewFeature`).
5. Open a Pull Request.
## License
This project is licensed under the GPL-3.0 License. See the [LICENSE](LICENSE) file for details.
## Authors
- **Ghost0159** - *Python scripts for generating JSON data on missing content* - [Ghost0159's GitHub Profile](https://github.com/Ghost0159)
- **Lenochxd** - *CSS, HTML, and web development* - [Lenochxd's GitHub Profile](https://github.com/Lenochxd)