[DOC] - Set up documentation about building and running the project

Vyvy-vi commented 2 years ago

What is incorrect in the documentation?

The documentation hasn't been added yet. We could add it in the README for now, or we could set up a docs folder with a documentation generator like docsify or docosaurus.

What should that text say?

Setting up discord bot:
- Login to the Discord Developer portal and create a new Application.
- Add a bot to the Application after selecting "Bot" from the left-side panel.
- Copy the bot's token.
- Go to the Oauth2 tab > URL Generator and select both bot and applications.commandss scopes, along with the Administrator permission. Copy the URL generated and invite the bot in your server.
- Copy the guild id of the server you invited the bot into.
Setting up env:
- Copy sample.env into .env
```
cp sample.env .env
```
- Paste the copied token from the discord developers portal as the value for the BOT_TOKEN variable.
- Paste the copied token from discord as the value for the GUILD_ID variable.
Installing Dependencies:
```
npm install
```
Building the Project:
```
npm run build
```
Running the bot
```
npm run start
```
Running the bot in development mode, with file-reloading
```
npm run start:dev
```

Additional information

No response

naomi-lgbt commented 2 years ago

You know me, I'm a sucker for Docsify.

naomi-lgbt commented 2 years ago

Opening this up for contribution - we'll want documentation in place ASAP so we can facilitate contributions!

Susmita-Dey commented 2 years ago

Opening this up for contribution - we'll want documentation in place ASAP so we can facilitate contributions!

You know me, I'm a sucker for Docsify.

We can have a documentation website using docsify

MrHerbalizer commented 2 years ago

Hi. Have created a basic docsify website:- https://mrherbalizer.github.io/developer-rubric-discord-bot/ I'm pretty rookie at writing a HTML/Markdown code.. There is a obvious room for improvement. Is adding images for installation steps a good idea?

MrHerbalizer commented 2 years ago

Also added Contributing.md. Want to ask, do we follow Semantic Versioning as our versioning scheme?

Vyvy-vi commented 2 years ago

Hello @MrHerbalizer, thanks for contributing to developer-skills-matrix-discord-bot. While we really appreciate contributions, it would be really great if contributors ask for being assigned to an issue before working on them. This can help us prevent contributors from working on the same issue, and getting disheartened due to competing PRs.

MrHerbalizer commented 2 years ago

Hi @Vyvy-vi. No problem. I am new to open source contribution and learning. I will take care of your suggestion while contributing next time. It was a good learning experience contributing here..:)

Semalab / developer-skills-matrix-discord-bot