This project was initially built as a personal project to create my own website (https://alexvcasillas.com) to test the latest features of the awesome MobX State Tree and GraphQL. The React part of this project is based on the latest Create React App stable release (check their docs for further knowledge).
The purpose of this project is only intended for learning. It's not intended to be a commercial product or any other related kind of stuff. This is Open Source so you should feel free to use it and modify it as you wanted. In fact, I encourage you to modify the structure or how I do things to fit your needs and the way you handle things, just set it to be comfortable to you.
If you want to try this project the first thing you have to do is to clone this repository. How? Just go to your favourite terminal and execute the following command (assuming that you previously have git installed):
git clone https://github.com/alexvcasillas/react-mobx-state-tree.git. By doing so, you'll have the repository cloned in your computer. The next step is to move inside by typing
cd react-mobx-state-tree. Alright, we're in now! You can't run it at this point because you have no dependencies installed so, we need to start with that, run the following command:
npm install or if you're a yarn user just
This might take a while because it's downloading all the minimum requirements as local dependencies so you can run this project (they're just a few). When it's done, you're good to go, simply run the following command
npm start or if you're a yarn user
yarn start and you will see the development build process and when everything is done, your browser will open a new window/tab with this project up and running.
If you want your Github profile to fill this project, you need to generate a Github's Personal Access Token (PAT) and go to
src/utils/graphql.js - line 10 and replace
const githubToken = 'your_token_here'; the content within single quotes with your Personal Access Token (PAT). Then just make the build and deploy it somewhere or just run it as development.
You can customize everything with Styled Components!
git clone https://github.com/alexvcasillas/react-mobx-state-tree.git
Because this project is based on Create React App, you have all the CRA available commands and the build process is delegated to them. Simply run
npm run build or
yarn build and the build process will being and, at the end of it, you'll have a
dist folder with your SPA ready to be deployed as a static website at any host.
This project is being used in:
I'm always looking to improve this project so, if you feel like you can contribute to it to improve any of it's features, just fork it and make a proper Pull Request. I'll be so glad to check it with you and merge it into the master project.
I want to thank the following people and organizations for creating all that this project is based on:
Michel Weststrate for the incredible job creating MobX and MobX State Tree.
Mattia Manzati for it's support with everything related to MobX State Tree.
Max Stoiber for it's awesome Styled Components 💅
Dan Abramov for creating Create React App (also all of the contributors to it!)
Apollo GraphQL Team for their awesome contribution with Apollo Client.