-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
106 changed files
with
6,348 additions
and
352 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
# Contributing | ||
|
||
Thanks for your willingness to contribute! Please make sure to check with me | ||
before doing a bunch of work on something. | ||
|
||
## Project setup | ||
|
||
If you do need to set the project up locally yourself, feel free to follow these | ||
instructions: | ||
|
||
### System Requirements | ||
|
||
- [Node.js](https://nodejs.org/) >= 20.0.0 | ||
- [npm](https://npmjs.com/) >= 8.18.0 | ||
- [git](https://git-scm.com/) >= 2.38.0 | ||
|
||
### Setup steps | ||
|
||
1. Fork and clone the repo | ||
2. Copy `.env.example` into `.env` | ||
3. Run `npm install && npm run setup -s` to install dependencies and run | ||
validation | ||
4. Create a branch for your PR with `git checkout -b pr/your-branch-name` | ||
|
||
> Tip: Keep your `main` branch pointing at the original repository and make pull | ||
> requests from branches on your fork. To do this, run: | ||
> | ||
> ``` | ||
> git remote add upstream https://github.com/epicweb-dev/epic-stack.git | ||
> git fetch upstream | ||
> git branch --set-upstream-to=upstream/main main | ||
> ``` | ||
> | ||
> This will add the original repository as a "remote" called "upstream," Then | ||
> fetch the git information from that remote, then set your local `main` branch | ||
> to use the upstream main branch whenever you run `git pull`. Then you can make | ||
> all of your pull request branches based on this `main` branch. Whenever you | ||
> want to update your version of `main`, do a regular `git pull`. | ||
If the setup script doesn't work, you can try to run the commands manually: | ||
```sh | ||
git clone <your-fork> | ||
cd ./epic-stack | ||
# copy the .env.example to .env | ||
# everything's mocked out during development so you shouldn't need to | ||
# change any of these values unless you want to hit real environments. | ||
cp .env.example .env | ||
# Install deps | ||
npm install | ||
# setup database | ||
prisma migrate reset --force | ||
# Install playwright browsers | ||
npm run test:e2e:install | ||
# run build, typecheck, linting | ||
npm run validate | ||
``` | ||
If that all worked without trouble, you should be able to start development | ||
with: | ||
|
||
```sh | ||
npm run dev | ||
``` | ||
|
||
And open up `http://localhost:3000` and rock! | ||
|
||
## Help Needed | ||
|
||
There's something to be said for custom code and the ability that grants with | ||
regard to tuning it to be exactly what you need. But there's also something to | ||
be said for offloading maintenance onto external dependencies. There are likely | ||
several bits of code in this codebase that could benefit from externalization. | ||
There could even be some things that could be improved by existing libraries. | ||
|
||
Feel free to take any code from within this project and turn it into an open | ||
source library (appropriate attribution is appreciated). Then come back and make | ||
a PR to use your new library. | ||
|
||
NOTE: Actual adoption of your library is not guaranteed. Offloading maintenance | ||
and adaptability is a delicate balance. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
Copyright © 2023 Kent C. Dodds | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of | ||
this software and associated documentation files (the “Software”), to deal in | ||
the Software without restriction, including without limitation the rights to | ||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of | ||
the Software, and to permit persons to whom the Software is furnished to do so, | ||
subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS | ||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | ||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER | ||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN | ||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.