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.

Sign up for GitHub

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

add stack and minial config to setup on local #67

Closed
wants to merge 2 commits into from
Closed

add stack and minial config to setup on local #67

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9da0c70
add stack and minial config to setup on local
olarno Apr 16, 2023
2074025
Merge branch 'develop' into Issues/65_update_documentation
vassilidev Apr 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 50 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,62 @@
<a href="https://discord.gg/3G8cvWr7q4" ><img width="30%" src="https://user-images.githubusercontent.com/28778964/230801380-b8fb2ed3-fbcd-42ac-8e03-e45eb7c06e5e.png" /></a>
</div>

---
<div align="center">

![GitHub](https://img.shields.io/github/license/geeksesi/code-review-pals)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/geeksesi/code-review-pals/.github/workflows/deploy.yml)
![GitHub issues](https://img.shields.io/github/issues-raw/geeksesi/code-review-pals)
![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/geeksesi/code-review-pals)

</div>

---

# Code Review Pals
Code Review Pals is a community-driven platform for code review, designed to help developers learn from each other and improve their skills by providing a place to share their code and get feedback from peers.

Our goal is to encourage developers of all levels to submit their code for review and to foster a supportive and collaborative environment where senior developers can help juniors learn and grow. We believe that code review is a vital part of the software development process, and that it helps improve code quality, catch bugs and security issues, and share knowledge.

## Contribution

```json
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think this json is not pretty.
just use

- PHP >= 8.1 ( prefer 8.2 )
- Laravel >= 10
- node.js >=  17.4
- MySQL >= 8
- Redis > 7
- and other ...

"license": "MIT",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

idk why json here ? just stack info can be good without this

"stack": {
"php": "^8.1",
"laravel": "^10.0",
"react": "^18.2",
"npm": "^8.12"
}
```

## Installation

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need a section for .env
about how configure login as github.
about redis, horizon queues,

also it will be awesome if we mention about Sail, it's easy to use

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Of course we need another layer here.
I don't know Sail and Horizon (give me some time to explore these) 👍

### Database

```
php artisan migrate --force
```

> *TODO add dummies data ?*
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove todo + add issue

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we don't have dummies data. yet.


### Local server

```
npm run build
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

build in local ?

php artisan config:cache
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

php artisan optimize

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why ? do not do this things for development. it's for production.
in develop cache route, view,... could affect to your develop process.

php artisan route:cache
php artisan view:cache
php artisan optimize
```
```
php artisan server
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we have sail too

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • serve and no server

INFO Server running on [http://127.0.0.1:8000].
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please do not put the output here. people will copy this without knowing what it is 😅

```

It is alive on your local.

# Contribution
If you're interested in contributing to Code Review Pals, please check out the [Issues](https://github.com/geeksesi/code-review-pals/issues) and join our community. Together, we can make code review a more accessible and rewarding experience for everyone.

## License
# License
Code Review Pals is Licensed under The MIT License (MIT). Please see [License File](https://github.com/geeksesi/code-review-pals/blob/master/LICENSE) for more information.