metamaps--metamaps/README.md

60 lines
2.1 KiB
Markdown
Raw Normal View History

2018-03-03 20:57:02 +00:00
Make sure you have `nodemon` and `node-sass` installed
`$ npm install -g nodemon node-sass`
2018-03-04 03:52:41 +00:00
Run the following at the same time, in two terminals
2018-03-03 20:57:02 +00:00
```
2018-03-04 03:52:41 +00:00
$ API=http://localhost:3001 nodemon server.js
2018-03-03 20:57:02 +00:00
$ node-sass -w sass/application.scss public/css/application.css
2018-03-04 03:52:41 +00:00
```
To run the server as a daemon that will be re-run if it crashes, you can
use the forever node package.
```
$ npm install -g forever
$ forever start server.js
```
2018-03-04 03:52:41 +00:00
Run the metamaps api in another terminal using
2018-03-06 13:58:28 +00:00
`$ rails s -p 3001`
Checklist
- [x] Get the Import lightbox working, and not conflicting on screen
- [x] Handling CSRF
- [x] Fix images referenced in the JS
- [x] Figure out how authentication of requests from the frontend to the API works
- [x] Figure out how to combine the nodejs realtime server into server.js
2018-03-08 12:26:04 +00:00
- [x] Notifications: make sure loading states are working for popup and page
2018-03-07 20:35:27 +00:00
- [ ] Notifications: make sure notifications either look nice, or redirect
- [ ] Notifications: pagination
2018-03-06 13:58:28 +00:00
- [ ] Get actioncable working
2018-03-08 12:26:04 +00:00
- [ ] lightboxes
- [x] Request unreadNotificationCount
- [x] Request invite code
2018-03-06 13:58:28 +00:00
- [x] Request user object itself
2018-03-08 12:26:04 +00:00
- [ ] About lightbox
- [ ] break up index.html into parts
2018-03-06 13:58:28 +00:00
- [ ] Handle CSS metacode colors
- [ ] Fix Request An Invite page
- [ ] Make 'new map' action work
- [ ] Modify the remaining rails templates into JSX templates
2018-03-07 20:35:27 +00:00
- [x] notifications list
- [x] notification page
2018-03-06 13:58:28 +00:00
- [ ] list metacodes
- [ ] new metacode
- [ ] edit metacode
- [ ] list metacode_sets
- [ ] new metacode set
- [ ] edit metacode set
- [ ] authorized apps
- [ ] registered apps
- [ ] authorize
- [ ] user passwords
- [ ] Modify the RubyOnRails app to only serve JSON responses, no HTML pages anymore
- [ ] Modify the RubyOnRails app to include an endpoint that responds with basic data the front end needs to display (such as the invite code for the user, and the current metamaps build) (a bunch of the data found here: https://github.com/metamaps/metamaps/blob/frontendonly/Metamaps.ServerData.js.erb)
- [ ] Modify the frontend to request that data from the API which is necessary at first to load the page
- [x] Load the metacodes
- [ ] Load the metacode sets