touhoufest-webapp is a web application that seeks to create a user-friendly schedule app for conventions at a fraction of the cost (i.e. free) of alternative cost-prohibitive convention apps. This specific iteration is a fork off of cjnwebapp specifically crafted for TouhouFest.
This project was bootstrapped with Create React App.
To adapt this project to fit needs of your convention, the below steps may be useful.
Fork this repo to make a copy of it on your GitHub account
git clone it to your local directory
cd /path/to/project/cjnwebapp and npm install (you will need NPM installed)
Modify src/events.csv to replace with your convention's events. Several notes:
a. It is highly recommended to open the CSV file in a spreadsheet editor of your choice. (e.g. Excel, Google Sheets, etc.) If you do so, be sure to save out to a CSV file with the , character used for column separation
b. The formatting used in the datetime columns need to be precisely followed
c. The event_age_limit column supports a variety of limits (e.g. "13+", "18+", etc.)
Replace the app's menupages with ones with information specific to your con by editing the ones in src/menupages/. Be sure to import and reference them in src/index.js
The "Best Waifu" entry in the footer can be removed at the bottom of src/App.js if you wish
Modify public/CNAME to the website domain of your choice. This project by default uses GitHub Pages for web hosting (by virtue of it being free) so usually this should be <yourusername>.github.io/cjnwebapp
a. If you wish to use a custom domain, be sure to put down that instead. For more information on getting GitHub Pages to work with custom domains, try this link.
Test the application before deploying with npm run start
Once you're assured that the fork is ready to go, run npm run deploy
Go to "Settings" > "Code and automation" > "Pages" in your GitHub repository's settings. A few options will need to be customized:
a. Set the Source to "Deploy from a branch"
b. Set the Branch to "gh-pages"
c. If you're using a custom domain, set it appropriately and wait for GitHub's DNS check to go through. You'll need to add a CNAME from your domain's account page as well, make sure it points to <yourusername>.github.io
After that, your web app should be good to go.
If there are any issues, please flag them in Issues.
In the project directory, you can run:
npm startRuns the app in the development mode.\ Open http://localhost:3000 to view it in your browser.
The page will reload when you make changes.\ You may also see any lint errors in the console.
npm testLaunches the test runner in the interactive watch mode.\ See the section about running tests for more information.
npm run buildBuilds the app for production to the build folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\ Your app is ready to be deployed!
See the section about deployment for more information.
npm run ejectNote: this is a one-way operation. Once you eject, you can't go back!
If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.