Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A documentation for new developers which details the installation steps of ABG #389

Open
Ribakys opened this issue Dec 28, 2021 · 3 comments

Comments

@Ribakys
Copy link
Contributor

Ribakys commented Dec 28, 2021

For the following uses:

  • To test ABG.
  • To develop new features, test them and push them to the main repository.
  • To make ABG work locally as a server and so that other distant players can connect to it.
  • To update its local code following updates from the main repository (in particular before developing new functionalities).

It would take detailed steps (more than in the main page), what software to use.

@Ribakys
Copy link
Contributor Author

Ribakys commented Jan 2, 2022

When I execute npm ci, this result now appear :

added 865 packages, and audited 866 packages in 6s
17 vulnerabilities (7 moderate, 9 high, 1 critical)

How to solve it ?

@jrmi
Copy link
Owner

jrmi commented Jan 2, 2022

When I execute npm ci, this result now appear :

added 865 packages, and audited 866 packages in 6s
17 vulnerabilities (7 moderate, 9 high, 1 critical)

How to solve it ?

It's not a blocking problem, some dependencies need to be updated but it's mainly dev dependencies. However feel free to update them if necessary.

@jrmi
Copy link
Owner

jrmi commented Jan 2, 2022

For the following uses:

* To test ABG.

Yes good idea.

* To develop new features, test them and push them to the main repository.

Some sort of Contributing guide, also a good idea.

* To make ABG work locally as a server and so that other distant players can connect to it.

We can add more details on this part but there is many ways to do this depending of your configuration and some "devops" skills are necessary to achieve complex installation (behind router, DNS configuration, etc.)

* To update its local code following updates from the main repository (in particular before developing new functionalities).

I don't think this part should be documented in ABG because it's a generic git/github related issue. Documentation already exist on this point. Maybe you need something more specific?

However I know it's a complicated action for all project and If you need help, feel free to ask me directly (on discord?).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants