-
Notifications
You must be signed in to change notification settings - Fork 78
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Explain source code structure * Add contributing info * Link to license
- Loading branch information
Showing
1 changed file
with
42 additions
and
1 deletion.
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 |
---|---|---|
@@ -1,7 +1,48 @@ | ||
# Fullstack GraphQL | ||
|
||
Book about full stack GraphQL development with React and Node. | ||
An open source book about full stack GraphQL development with React and Node. | ||
|
||
<a href="https://graphql.college/fullstack-graphql">https://graphql.college/fullstack-graphql</a>. | ||
|
||
<a href="https://graphql.college/fullstack-graphql"> | ||
<img src="manuscript/images/title_page.png" width="400px" alt="Cover" /> | ||
</a> | ||
|
||
## Structure | ||
|
||
Each chapter is written in a markdown file in the `manuscript` folder. | ||
|
||
Every image in the book is located in `manuscript/images`. | ||
|
||
The order of the chapters is determined by the `Book.txt` file. | ||
|
||
`Sample.txt` defines the content of the book's sample chapter. | ||
|
||
## Contributing | ||
|
||
All types of contributions are welcome! Here is a little guide on how to contribute. | ||
|
||
### Bugs/Typos | ||
|
||
If you see a bug or typo please open a github issue. | ||
|
||
### Fixes | ||
|
||
To contribute with code fixes, please remix the example on Glitch and create a Pull Request referencing the fix's Glitch URL. | ||
|
||
### New chapters | ||
|
||
Please file an issue to suggest new chapters. Chapter suggestions are always welcome! But please don't create a PR with a new chapter before discussing about it, because it may not get accepted. Your time is golden, use it well! | ||
|
||
### Questions | ||
|
||
If you have any questions regarding the book, or GraphQL in general, please create a new conversation in https://spectrum.chat/graphql instead of a Github issue. | ||
|
||
## License | ||
|
||
![CC](https://creativecommons.org/images/deed/cc_blue_x2.png) | ||
![Attribution](https://creativecommons.org/images/deed/attribution_icon_blue_x2.png) | ||
![NC](https://creativecommons.org/images/deed/nc_blue_x2.png) | ||
![SA](https://creativecommons.org/images/deed/sa_blue_x2.png) | ||
|
||
This book is licensed under a [Creative Commons Attribution Non Commercial Share Alike 4.0 International](https://creativecommons.org/licenses/by-nc-sa/4.0/) license. |