Skip to content

Commit 50be033

Browse files
committed
updated code/ raedme
1 parent 53057df commit 50be033

33 files changed

+1670
-530
lines changed

.editorconfig

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# EditorConfig is awesome: http://EditorConfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
# Tab indentation
7+
[*]
8+
charset = utf-8
9+
indent_style = space
10+
indent_size = 2
11+
insert_final_newline = true
12+
trim_trailing_whitespace = true

.env-sample

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
DB_URL=localhost

CONTRIBUTING.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
##Contributing##
2+
3+
Where to start
4+
5+
There are many different ways to contribute to **rest-api-node-typescript**'s development, just find the one that best fits with your skills. Examples of contributions we would love to receive include:
6+
7+
- Code patches [pull request](https://help.github.com/articles/creating-a-pull-request/)
8+
- Documentation improvements
9+
- Translations(yet to come)
10+
- Bug reports
11+
- Patch reviews
12+
- UI enhancements
13+
14+
When contributing to this repository, please first discuss the change you wish to make via issue or any other method with the owners of this repository before making a change.
15+
16+
Please note we have a code of conduct, please follow it in all your interactions with the project.
17+
18+
##Reporting Issues##
19+
20+
Have you identified a reproducible problem in this repo? Have a feature request? We want to hear about it! Here's how you can make reporting your issue as effective as possible.
21+
22+
##Look For an Existing Issue##
23+
Before you create a new issue, please do a search in open issues to see if the issue or feature request has already been filed.
24+
25+
Be sure to scan through the most popular feature requests.
26+
27+
If you find your issue already exists, make relevant comments and add your reaction. Use a reaction in place of a "+1" comment:
28+
29+
👍 - upvote
30+
31+
👎 - downvote
32+
33+
If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below.
34+
35+
##Writing Good Bug Reports and Feature Requests##
36+
File a single issue per problem and feature request. Do not enumerate multiple bugs or feature requests in the same issue.
37+
38+
Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar but have different causes.
39+
40+
The more information you can provide, the more likely someone will be successful in reproducing the issue and finding a fix.
41+
42+
Please include the following with each issue:
43+
44+
- OS
45+
- The version of Node.js, npm / yarn
46+
- Reproducible steps (1... 2... 3...) that cause the issue
47+
- What you expected to see, versus what you actually saw
48+
- Images, animations, or a link to a video showing the issue occurring
49+
- A code snippet that demonstrates the issue or a link to a code repository the developers can easily pull down to recreate the issue locally
50+
- **Note**: Because the developers need to copy and paste the code snippet, including a code snippet as a media file (i.e. .gif) is not sufficient.
51+
- Errors from the Dev Tools Console (open from the menu: Help > Toggle Developer Tools)
52+
53+
##Thank You!##
54+
Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.

Readme.MD

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ This is a simple REST API developed using node and express with typescript
1313
1) you need to install PostgreSQL and then set the following environment variable
1414
`C:\Program Files\PostgreSQL\10\bin`,
1515
`C:\Program Files\PostgreSQL\10\lib`
16-
2) in the db.ts file the DB connection string need to be updated accoring to `credentials`.
16+
2) rename `.env-sample` to `.env` in the file the DB connection string need to be updated accoring to your `credentials`.
1717
ex : `postgres://<YourUserName>:<YourPassword>@localhost:5432/<YourDatabase>`
1818

19-
3) you can find the DB and other details under `server/db`
19+
3) you can find the DB and other details under `src/db`
2020
create database with the name `complete-typescript-course` and then run/ import the `.sql` files
2121

2222
## Setup

0 commit comments

Comments
 (0)