codeforcauseorg / edu-server Goto Github PK
View Code? Open in Web Editor NEWLicense: MIT License
License: MIT License
By creating a separate development branch it will be easy to test a set of changes done prior to deployment.
The requests are already autogenerated, we have to generate response body for the controller.
ref: https://docs.nestjs.com/openapi/operations
Currently the project has master
branch as default delete it and make the main
as default branch.
setup swaggerui/openapi for api documentation, so that frontend developers will be able to know each an every api contract easily
references: https://docs.nestjs.com/openapi/introduction
Lean mongoose doc: https://mongoosejs.com/docs/tutorials/lean.html
Currently we are returning the whole document even if the model doesn't need any further processes. Using lean with the models can be 10x more memory efficient.
The requests are already autogenerated, we have to generate response body for the controller.
ref: https://docs.nestjs.com/openapi/operations
Is your feature request related to a problem? Please describe.
The issue is created as per the context mentioned at the JBoss Link for creating a schema for contest on the platform, which can be extended to assignments and update user schema for rating/ranking.
Describe the solution you'd like
Creating models for storing the questions and pairing them randomly for contest on basis of the request for contest and difficulty level.
Additional context
It would be helpful if you can provide with any schema attributes in your mind.
Describe the bug
There is a test should be created
it is for the user to be created but it is currently used for getting all the users.
To Reproduce
We can make another test to get all users and for the current test of should be created
we can use it to create a new user.
If this issue is valid please assign this to meπ
Describe the solution you'd like
I have learned unit testing recently and would like to write test for the application server so that, we can test individual components before hand to ensure a smooth flow while the whole application runs.
Describe alternatives you've considered
Additional context
The server is going to use MongoDB for execution. It will be easier to not setup DB locally and to use a docker container for the same.
docker-compose.yml
under docker
dirFirebase admin credentials should not be stored in git. For that, every contributor needs to use their own firebase project account for development purposes.
Provide steps in README to make it easier for contributors.
Add Swagger doc for the course controller API, It should cover all the get, post and put requests.
It's important to use nestJs cli plugin to reduce the overall complexity of DTO and improve future readability. https://docs.nestjs.com/openapi/cli-plugin
Currently pushing changes requires manual efforts, there is a need to automate the process of pushing latest changes to heroku.
If npm run lint:fix
is put up in Github workflows, it would be a lot of time-saving tasks for contributors.
Describe the bug
After setting up the project, when i use npm run start:dev it give a error that tsc-watch is not defined.
To Reproduce
Expected behavior
It should start running the server in watch mode.
Desktop (please complete the following information):
Additional context
it throws the error because package.json doesn't contain tsc-watch, we can install it under dev dependencies by npm i tsc-watch -D
The requests are already autogenerated, we have to generate response body for the controller.
ref: https://docs.nestjs.com/openapi/operations
Is your feature request related to a problem? Please describe.
We need to add schemas for the server for example users, courses, doubts, contests, assignments, etc. So that they can be properly stored in the database.
Describe the solution you'd like
Adding models of MongoDB schemas as described in docs for nestjs.
I will modify the README FILE same like this starting from forking and how to contribute.
Please Assign me the task @KeenWarrior @kunal-kushwaha @Abhishek-kumar09
https://whimsical.com/XMU4Fx3UejnYUnvCetkXuc
I've made a place for all the common schemas in whimsical>
@Abhishek-kumar09 @KeenWarrior it would be great if u could tell us about the schemas and also their objects ..
Then I can start making them and also send a PR for them
Currently due to typescript behaviour interfaces are not transpiled and their metadata with themself are lost during runtime thus no pipes could be used on them that makes them unwanted piece of code that are just increasing code lenth and nothing more, moreover we can add interfaces if they are needed in future due in some very special cases but none is there at this point of time.
Apply pagination for get all channel discussions etc. Use TypeOrm Querybuilder Skip Method
Describe the bug
This is more of a Nest code-practices-related bug.
The following @Res
approach disables the Standard Approach in NestJS as discussed in the documentation here which helps in auto serialization to JSON
Screenshots (If applicable)
Desktop (please complete the following information):
Additional context
To solve this bug, I would request, to add the following
@Res({ passthrough: true })
Add Wishlist Course response
[
{
"cId": "6079e2c7294dcf960d3036be"
}
]
cid should not be there, it should be stored in the form of array of courseId
[
{
...all the course detail of the wishlist
}
]
The requests are already autogenerated, we have to generate response body for the controller.
ref: https://docs.nestjs.com/openapi/operations
We need to create an issue template for this project which would be great for maintainers and contributers. I would like to take up this task.
Is your feature request related to a problem? Please describe.
We need to add tests for GitHub Actions to check all PRs.
Describe the solution you'd like
We can start this with properly configuring ESLint, such that we add another script to the project, which we then run using GitHub actions.
Describe alternatives you've considered
We can use either GitHub actions or stuff like Travis CI.
Is your feature request related to a problem? Please describe.
If this application is gonna use MongoDB as a database solution, I would like to implement the mongo technique.
Describe the solution you'd like
By injecting the mongoose module we can have a clean way to creating and accessing schema in the application.
If this application is going to use MongoDB and the maintainers are fine with this, please assign this issue to me.
Create a pull request that covers all the requirements for A perfect Pull request and is not limited to:
I would like to add contributing guidelines to the repo. Kindly let me know if I can take this up. Any suggestions are welcome. Thank you.
Hi @KeenWarrior,
After "npm install", when i run "npm run start", It is showing this:
But ./service.json doesn't exist in the whole project.
The requests are already autogenerated, we have to generate response body for the controller.
ref: https://docs.nestjs.com/openapi/operations
edu-server/src/modules/user/user.controller.ts
Lines 135 to 155 in d85b27f
The code is not working as expected due to way the way data is stored. It doesnt delete the wishlist course
Is your feature request related to a problem? Please describe.
Add the contributor's section in the Readme.md like this :
Describe the solution you'd like
Add required links
for ex: <a href="https://github.com/codeforcauseorg/edu-server/graphs/contributors"> </a>
for changing image positions according to commits.
And for image you can use this <img src="https://contrib.rocks/image?repo=codeforcauseorg/edu-server" />
And use proper formatting.
Describe the bug
To Reproduce
Expected behavior
Screenshots (If applicable)
Desktop (please complete the following information):
Smartphone (please complete the following information):
Additional context
Describe the bug
Right now we are able to add the same course multiple times in the wishlist array of the same user.
To Reproduce
We can resolve this by adding a condition whether currseId exists in that user wishlist array if yes we can give an exception.
Is your feature request related to a problem? Please describe.
In the documentation, nothing is written about MongoDb Setup. Contributors might think that MongoDB is not needed before running the project.
Describe the solution you'd like
Add how-to setup and run Mongodb before step 4 in the documentation.
Is your feature request related to a problem? Please describe.
Right now more than half of the README is the same as that of a NestJS boilerplate, starting with the logo on the top.
Describe the solution you'd like
The README needs to be changed according to the project description.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. πππ
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google β€οΈ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.