santi224m / assetto-corsa-garage Goto Github PK

Assetto Corsa Garage was created to make it easier for sim racers to find the mods they are looking for. The sim racing community has a lot of mods that users can download, but they are spread all over the internet. And even when mods are on the same site, it can be hard to look through all of them because there is no way of filtering them. Assetto Corsa Garage fixes this by requiring every mod to be uploaded with the same information including: brand, car class, model year, and shifter type. Assetto Corsa Garage doesn't host the mods on the app, but it contains links to the mods on other sites. This app allows sim racers to contribute to the site by allowing them to link their favorite mods for other sim racers to find. This ensures that the newest mods will always be on the site.

If you would like to contribute to the site, feel free to work on one of the issues and make a pull request. Developers of all skill levels are welcome to contribute. If you need help getting the app to run on your local machine follow the steps below.

Fork the repository to add a copy of this repository to your account.

Now head to your copy of the repository and clone the forked repository to your machine. Click the green "Code" button and copy the url. You will use this url in the following command on your terminal. The "this-is-you" part should be replaced with your github username.

git clone https://github.com/this-is-you/assettoCorsaGarage.git

Change your directory to the newly cloned repository

cd assettoCorsaGarage

Create a new branch

git checkout -b new-branch-name

Before you can run the app, create a firebase account so that you can run a development database.

Once you get the api keys from firebase, you can move on to the next step.

Create a "dev.js" file in the "src/config" directory.

Copy the following code into your "dev.js" file

module.exports = {
    firebaseApiKey: 'your-key',
    firebaseAuthDomain: 'your-key',
    firebaseProjectId: 'your-key',
    firebaseStorageBucket: 'your-key',
    firebaseMessagingSenderId: 'your-key',
    firebaseAppId: 'your-key',
    firebaseMeasurementId: 'your-key',
    firebaseDatabaseURL: 'your-key',
    adminId: 'your-key',
};

Replace the "your-key" strings with the corresponding key and save the document.

You can download the following JSON file and import it into your firebase realtime database so that you don't have to manually upload mods to your development database.

Download Firebase JSON

Install the dependencies before you run the app

npm install

Sometimes the "react-scripts" file won't install so run the following command:

npm install react-scripts --save

Now you can start the app

npm start

Now you can make the changes in the code and when you are done, commit the changes.

git add file-changed-1 file-changed-2

or to commit all files changed

git add .

Now that you added the files you changed you can commit them

git commit -m "Description of your commit"

Now that you commited your changes to git, you can push them to GitHub.

git push origin <add-your-branch-name>

Now that you pushed your changes to GitHub, you can make a pull request for your code to be reviewed and hopefully merged.

You can add a comment describing what you changed and then click "Create pull request".

Now all you have to do is wait for your code to be reviewed and will you recieve a notification once it is merged or if additional changes need to be made.