Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better Documentation (README.md) #113

Open
6 tasks
aitikgupta opened this issue Apr 12, 2021 · 0 comments
Open
6 tasks

Better Documentation (README.md) #113

aitikgupta opened this issue Apr 12, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers maintenance Flake8 for Python, ESLint for JavaScript

Comments

@aitikgupta
Copy link
Member

Currently, we fail to explain a lot of the functionality we've built over this sprint.

The current README.md needs a redesign:

  • We show project structure (backend/ for FastAPI server, frontend/ for client code built with React components)
  • We tell a bit about how DCT-DWT Transformations work (Probably not for a newcomer, but still needs to be addressed)
  • We modularize the discussion into two parts, backend work (deployed on Heroku - http://sociomark-backend.herokuapp.com/) and frontend work (deployed on Netlify - https://sociomark.netlify.app/)
  • GitHub Badges (For lints, Flake8 and ESLint, Prettier) - GitHub Actions are already present
  • We explain the reproducing steps (the .env parts), and how to build on Windows (apparently doing this:
    javascript NODE_ENV=development npm run start
    doesn't work on Windows^)
  • We tell a bit about the MongoDB backend (deployed on MongoDB Atlas)
@aitikgupta aitikgupta added documentation Improvements or additions to documentation help wanted Extra attention is needed maintenance Flake8 for Python, ESLint for JavaScript labels Apr 12, 2021
@aitikgupta aitikgupta added good first issue Good for newcomers and removed help wanted Extra attention is needed labels Apr 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers maintenance Flake8 for Python, ESLint for JavaScript
Projects
None yet
Development

No branches or pull requests

1 participant