Repo for redoing the DNB Visitt application with Node.js, React, Firebase, Heroku, and Travis. Whew.
Running npm install in both folders will sort this. Or, if you're on a Unix-based system, and have concurrently installed npm run install-all (or yarn add-all for yarn users) will install all the necessary dependencies in both folders.
This will start the server on port 5000. This is only useful for activating email services, however, and with the restrictions of the free Mailgun account, emails will only be sent to one of a set of six predefined addresses. However, not running the server, might lead to some unexpected behavior on mail sending attempts.
This will run the dev server from localhost:3000. Hot reloading is enabled so anytime anything is saved, the app reloads reflecting changes. Note: this only loads the frontend of the site, although it is nearly fully functional on its own.
This will start both the server and the frontend, assuming you're in the root folder.
Facebook's own front-end JavaScript library. Totally cool.
Appears to be the most recommended way of dealing with state in React. Oh, and I love it.
Free, quick, no-server, NoSQL database. Denormalize!
Deployment service, so that the page can always be found somewhere. Note: not publicly available.
Continous integration service that will run tests, make sure the build succeeds on a server (hint: a lot of them run Linux!), and can, optionally, deploy to a hosting service of your choice. They're good guys.
Good point! While there didn't seem to be a need for it originally, an Express server was created to support sending emails on booking and inquiries.
Root folder is separated into server and react-ui. The former naturally has configuration relating to the node server, while the latter contians the frontend of the website.
All files to be deployed must go in src. Other files, e.g. for documentation, can go anywhere else in the directory.
Generally the project is structured into a few main folders:
components: contains the presentational components
All subfolders are organised by main page, and then any subcomponents they use. Try and keep components and other dependencies as local as possible.
redux: contains the state and logic of the application
firebase: Contains files relating to the database
mailHandler: Contains mail handling functions.
routing: Contains the website paths and routing setup
helperFunctions: contains a number of useful functions used throughout the project.
This project uses JavaScript Standard Style. Some basic usage is outlined below. For more info, see https://www.npmjs.com/package/standard
Presents a list of issues in your code, or nothing if none are found
This will try and fix as many errors as it can, but there are certain things it cannot handle. These must be fixed manually.
Use them. A lot. It's much better to have many, short-lived branches, than few long ones. Make them small enough that you can go through a few a day, even.
Oh, and remember to delete them (both upstream and locally) when they're not useful anymore!
Accepted naming conventions
feature/my_new_feature — new features
bugfix/breaking_bug — bugfixes
style/new_styling — pure styling
refactor/thing_to_refactor — refactoring
x/my_exciting_test_feature — for experimental stuff that might never make it in to the actual project
Commit early, commit often. Push when you have something implemented, so that it won't break anyone's experience should they jump on your branch.
Go ahead and grab the alias mergetest from the .gitconfig example. This is a very handy tool, which'll tell you whether you'll get any conflicts or not.
Stay up to date with master and merge it into your branch whenever it updates (git merge master). This decreases the chance of conflicts
Also, before merging back into master, it's not a bad idea to merge master into your branch first, thereby avoiding conflict resolving on master.
See the git resources folder for an example of a .gitconfig file whith a lot of useful aliases etc.
Want to create custom commands? Want git gud or git rekt to acutally do something useful? Well, you can! Just configure them in your .gitconfig file!
This is a set-up I've been recommended by a very tech-savvy and terminal-happy coworker of mine.
This is my setup (using theme powerlevel9k), and it rocks my socks.