Udacity Alumni Client App
Getting Started
The project started as a fork of the Scalable React Boilerplate project. Please reference the repository for details on the features and conventions of the boilerplate.
We have switched to using Yarn as the official package manager for this project. Please install it globally with npm install -g yarn. I hope after this that you never again run into npm issues :tada:.
Installing
The package.json file includes over a dozen npm scripts to make most tasks a breeze.
Installation can be achieved by running
npm run setupTo get the development server running, please run
npm run startand navigate to http://0.0.0.0:1337
To run the test suite, please run npm run test, which will pick up any file with the word 'test' in its name.
Again, please reference the Scalable React Boilerplate project for details regarding the scripts.
Grommet Udacity
We are using an amazing React component library that will accelerate our development in this and any future projects. The Grommet library has been forked and published to the grommet-udacity npm package. We will be using this package in our projects and also will be adding stylesheets and components so that we have a maintainable component library for all future projects. Please refer to the Grommet Udacity wiki for more information.
Deployment
The project will be deployed via Docker to an ExpressJS server. Configuration will be included with the starter project.
In addition, a live version of this project can be deployed using the following button:
Built With
- Node
- React
- Redux
- Scalable React Boilerplate
Contributors (emoji-key)
 Ryan Collins 💁 📝 🐛 💻 🎨 📖 💡 🚇 👀 ⚠️ 🔧 ✅ 📹 |
 Andreas Daiminger 💻 📖 ⚠️ |
 Martin Breuss 🐛 📖 |
 James Ives 🐛 📖 |
 zhangs 💁 📖 |
 Jacob Bryan 💁 🐛 📖 |
 Akshay Dahiya 💁 |
|---|---|---|---|---|---|---|
 Natalie Baker 💁 🎨 📖 |
 Abhishek Ghosh 💻 🎨 📖 📢 |
 Kelli Blalock 💁 📖 🐛 💻 |
Contributing
Please see the Contributing.md file for details of the Code of Conduct and contributing guide.
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Troubleshooting
When working with a team on a project that uses Node, it is important that everyone use the same version of node and npm. In the case of this project, we are using Node version 5.2.0.
Instructions for installing NVM and setting your node version for the project can be found here.
More troubleshooting steps are found here: https://github.com/udacityalumni/alumni-client/wiki/Troubleshooting
Acknowledgments
Thank you to all of the contributors. We will put your name here after you have made a significant contribution to the project.