metamaps--metamaps/README.md

78 lines
2.8 KiB
Markdown
Raw Normal View History

2018-03-08 23:45:22 +00:00
Make sure you're running a good up to date LTS version of `node`, like 8.9.4
2018-03-08 23:45:22 +00:00
Make sure you have `node-sass` installed
`$ npm install -g node-sass`
2018-03-08 23:45:22 +00:00
Run the following at the same time, in TWO SEPARATE terminals. We tell the server where the backend process is running with the API environment variable
JS files, and CSS will rebuild automatically, just refresh the page
If coding the server itself, you will have to use nodemon, or kill and restart the server process manually
2018-03-03 20:57:02 +00:00
```
2018-03-08 23:45:22 +00:00
$ API=http://localhost:3001 node 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
```
2018-03-08 23:45:22 +00:00
To make sure the css files get built, use the following in another terminal
```
2018-03-08 23:45:22 +00:00
touch sass/application.scss
```
2018-03-08 23:45:22 +00:00
Run the metamaps api in another terminal using (on port 3001, so the UI can talk to it)
For now, make sure you are running on the `add-user-route` branch of Metamaps, and that it's up to date with the latest on that branch
2018-03-06 13:58:28 +00:00
`$ rails s -p 3001`
2018-03-08 23:45:22 +00:00
open up http://localhost:3000 and start coding!
2018-03-06 13:58:28 +00:00
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
- [x] Request unreadNotificationCount
- [x] Request invite code
- [x] Request user object itself
- [x] Load the metacodes
2018-03-08 15:43:39 +00:00
- [x] move ImportDialog lightbox into main app
2018-03-08 15:22:11 +00:00
- [x] create topic form
2018-03-08 17:09:23 +00:00
- [x] Fork map lightbox / component
2018-03-08 15:43:39 +00:00
2018-03-08 23:35:47 +00:00
- [ ] fix other places where metacode sets are used
- [ ] make newtopic form load metacodes from users selected ones
- [ ] create synapse form
2018-03-08 15:43:39 +00:00
- [ ] replace old loader with react loader
- [ ] ensure exports of maps work
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
- [ ] About lightbox
- [ ] Switch Metacodes lightbox / component
2018-03-08 12:26:04 +00:00
- [ ] 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
- [x] list metacodes
2018-03-10 00:30:55 +00:00
- [x] new metacode
- [x] edit metacode
- [x] list metacode_sets
2018-03-09 20:53:46 +00:00
- [x] new metacode set
- [x] edit metacode set
2018-03-06 13:58:28 +00:00
- [ ] authorized apps
- [ ] registered apps
- [ ] authorize
- [ ] user passwords
- [ ] Modify the RubyOnRails app to only serve JSON responses, no HTML pages anymore
- [ ] Modify the frontend to request that data from the API which is necessary at first to load the page
2018-03-08 23:35:47 +00:00
- [x] Load the metacode sets
2018-03-08 23:45:22 +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
```