Skip to content

Commit 5daa3e3

Browse files
committed
updated read me
1 parent 2732f2c commit 5daa3e3

File tree

2 files changed

+22
-5
lines changed

2 files changed

+22
-5
lines changed

.vscode/settings.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
"editor.formatOnPaste": true,
44
"prettier.singleQuote": true,
55
"prettier.trailingComma": "all",
6-
"prettier.tslintIntegration": true,
76
"editor.fontFamily": "Fira Code, Consolas, 'Courier New', monospace",
87
"files.exclude": {
98
"**/*.js": {

Readme.MD

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This is a simple REST API developed using node and express with typescript
44

5-
![alt text](https://image.ibb.co/nAd9OF/logos.png 'Node Typescript')
5+
![alt text](https://image.ibb.co/nAd9OF/logos.png "Node Typescript")
66

77
## ❤️ Found this project useful?
88

@@ -34,6 +34,24 @@ If you found this project useful, then please consider giving it a ⭐️ on Git
3434

3535
you can change port in `.env` file check `.env-sample`
3636

37+
## Features
38+
39+
- CURD operations for Cources
40+
- CURD operations for Lessons
41+
- REST API Request object validations - Basic
42+
- Error Logs
43+
- Seeder for DB
44+
45+
## Planned
46+
47+
- JWT login
48+
- Postman collections
49+
- Improve request Object Validations
50+
- Improve Error Messages for request failures
51+
- Project / DB Setup in Ubuntu - Docs
52+
- Security
53+
- Hosting
54+
3755
## Contributing
3856

3957
Awesome! Contributions of all kinds are greatly appreciated. To help smoothen the process we have a few non-exhaustive guidelines to follow which should get you going in no time.
@@ -50,22 +68,22 @@ I welcome and encourage all pull requests. It usually will take me within 24-48
5068

5169
- Match the document style as closely as possible.
5270
- Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
53-
- Pull requests must be made against master branch for this particular repository.
71+
- Pull requests must be made against `development` branch for this particular repository.
5472
- Check for existing [issues](https://github.com/nmanikiran/rest-api-node-typescript/issues) first, before filing an issue.
5573
- Make sure you follow the set standard as all other projects in this repo
5674
- Have fun!
5775

5876
## Created & Maintained By
5977

60-
Mani Kiran | @nmanikiran && Tushar Gupta | @curioustushar
78+
[@nmanikiran](https://github.com/nmanikiran) | [@curioustushar](https://github.com/curioustushar)
6179

6280
Feel free to reach out to me through @nmanikiran if you have any questions or feedback!
6381

6482
## Recommended / Preferred
6583

6684
[VSCode](https://code.visualstudio.com/download)
6785

68-
## Credits to
86+
## Thanks & Credits to
6987

7088
- Envato Tuts+ [30 Days to Learn HTML & CSS (Full Course)](https://www.youtube.com/playlist?list=PLgGbWId6zgaWZkPFI4Sc9QXDmmOWa1v5F)
7189
- Wes Bos [JavaScript30](https://www.youtube.com/playlist?list=PLu8EoSxDXHP6CGK4YVJhL_VWetA865GOH)

0 commit comments

Comments
 (0)