search

harunurhan / repodoctor

Tool for ranking and improving github repos based on best practices
MIT License
2 stars 2 forks source link

Flow of the app - [TECHNICAL] #11

Open harunurhan opened 8 years ago

harunurhan commented 8 years ago
  1. GET / (home)
  2. Run entry.jsx
  3. Render all components used in containers/Index.jsx starting from Index.jsx itself.
  4. Clicking CHECKUP button, makes a POST to /api/checkup with form data
  5. Return result (as json) if any checkup result exist on our database for this project and see progress indicator for next step ( doing new checkup...)
  6. Run checker scripts against the user's repository
  7. Update database with results
  8. Return results (from database, not directly for now) to react app as JSON

After we finalize the format of JSON reponse, we will change little bit of code and the props of react components, then react will handle the UI update.

We need to decide if that flow is OK before starting to code, everything after the 4th step doesn't seem cool enough to me

We need to discuss what should be in response, update everything according to that such as Models #9 , implementation of /api/checkup

harunurhan commented 8 years ago

Since the project is in very early stage of the development, I decided not to use DB for now, just run checker and return current results for each request.