Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/notmyself/rocksmith-plus-tools
A set of tools for Rocksmith+
https://github.com/notmyself/rocksmith-plus-tools
beginner codespaces codespaces-friendly hacktoberfest javascript learn nodejs rocksmith
Last synced: about 11 hours ago
JSON representation
A set of tools for Rocksmith+
- Host: GitHub
- URL: https://github.com/notmyself/rocksmith-plus-tools
- Owner: NotMyself
- License: mit
- Created: 2022-10-28T17:51:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-21T21:44:34.000Z (12 months ago)
- Last Synced: 2024-04-14T15:11:15.784Z (7 months ago)
- Topics: beginner, codespaces, codespaces-friendly, hacktoberfest, javascript, learn, nodejs, rocksmith
- Language: JavaScript
- Homepage: https://iamnotmyself.com
- Size: 62.5 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Rocksmith+ Tools
[](#contributors)
A set of tools for Rocksmith+
## Getting Started
This project contains [Development Containers](https://containers.dev/) definitions and is intended to be worked on using development containers. This ensures you have all the tools needed to build and run these tools available in the development environment.
Develoment Containers can be run both [locally](#running-locally) or via [GitHub Codespaces](#running-in-codespaces).
### Environment Variables
This project uses dotenv to externalize strings that might change or are secret and should not be commited to source control. The file **sample.env** contains the required variables along with default values. If the value is a secret it is left blank and must be populated before the code runs.
To use the default values, write them to a .env file located at the root of the workspace using this command:
```bash
cat sample.env > ./.env
```
### NPM Scripts
Currently, the tools are run via npm scripts. The following table lists the available commands.
|
Command | Debug Menu | Purpose |
|---|---|---|
|npm run data:clean| N/A | Removes the `./data` and `./logs` directories.|
| npm run data:refresh | Refresh Data | Fetches a list of genres and all associated songs. Then writes them to the `./data` directory. |
**Note:** Direct CLI commands can be run in the container using the VSCode by hitting **CMD+`** to bring up the terminal.
**Note:** The code can be run in a debugger, but selecting the debug menu name from the Run and Debug menu in VSCode.
## Running in CodeSpaces
1. [Fork the repository](https://github.com/NotMyself/rocksmith-plus-tools/fork) to your GitHub account.
1. Click the green **Code** dropdown button.
1. Select the **Codespaces** tab.
1. Click the green **Create codespace on main** button.
## Running Locally
1. Ensure your system meets the [requirements](#requirements).
1. Ensure Docker for Desktop is running.
1. Clone the repository: `git clone [email protected]:NotMyself/rocksmith-plus-tools.git`.
1. Change directory into the cloned repository `cd rocksmith-plus-tools`.
1. Open the project in VSCode `code-insiders .` or `code .` depending on what version you chose to install.
1. When prompted, select the **Reopen in Container** option.
### Requirements
1. Install [Docker Desktop](https://www.docker.com/products/docker-desktop/)
1. Install [VSCode](https://code.visualstudio.com/), the [Insiders Edition](https://code.visualstudio.com/insiders) is highly recommended.
1. Install [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension for VSCode
## Contributing
Want to contribute? Check out our [Code of Conduct](./docs/CODE_OF_CONDUCT.md) and [Contributing](./docs/CONTRIBUTING.md) docs. This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
There are many topics yet to be covered by this set of koans. I have added a handful of needed topics as [issues](https://github.com/NotMyself/rocksmith-plus-tools/issues) and tagged them as [Up for Grabs](https://github.com/NotMyself/rocksmith-plus-tools/issues?q=is%3Aopen+is%3Aissue+label%3A%22Up+for+Grabs%22). There are even some specifically tagged as [Beginner Friendly](https://github.com/NotMyself/rocksmith-plus-tools/issues?q=is%3Aopen+is%3Aissue+label%3A%22Beginner+Friendly%22).
If you have never contributed to an open source project, let those be your first. I promise to work with you to get your contribution into the repository and be friendly and encouraging about it. It is what Jim would have done.
If you think a topic is missing, propose it's inclusion by [submitting an issue](https://github.com/NotMyself/rocksmith-plus-tools/issues/new) yourself. Or better yet submit the issue and an accompanying pull request with how you think the topic should be introduced. Think about beginners in your effort; be clear and informative, be concise and most of all be playful with your examples.
## Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
