You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-28
Original file line number
Diff line number
Diff line change
@@ -32,11 +32,12 @@ This repository contains the source code for a E-commerce API built using Node.j
32
32
33
33
## Features
34
34
35
-
- User authentication and authorization.
36
-
- CRUD operations for users, jobs, and applications.
37
-
- JWT-based authentication for secure API access.
38
-
- RESTful API design.
39
-
- Written in TypeScript for enhanced maintainability and type safety.
35
+
-**User Authentication:** Register, login, and manage user accounts with JWT-based authentication.
36
+
-**Product Management:** CRUD operations for products.
37
+
-**Shopping Cart:** Add, update, and remove items in the shopping cart.
38
+
-**Order Management:** Place orders and view order history.
39
+
-**Stripe Payment Gateway:** Integrate Stripe for secure payment processing.
40
+
-**MongoDB Integration:** Store and manage data using MongoDB.
40
41
41
42
## Getting Started
42
43
@@ -48,6 +49,7 @@ You need to have the following software installed on your computer:
48
49
49
50
-[Node.js](https://nodejs.org/) (LTS version recommended)
50
51
-[npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/) or [Yarn](https://yarnpkg.com/) package manager
52
+
- Stripe account and API keys
51
53
52
54
### Installation
53
55
@@ -62,7 +64,7 @@ You need to have the following software installed on your computer:
62
64
3. Navigate to the project directory:
63
65
64
66
```bash
65
-
cdportfolio-nextjs
67
+
cdecommerce-api-nodejs
66
68
```
67
69
68
70
4. Install the project dependencies:
@@ -113,33 +115,14 @@ By default, the application will run on port `3000`. You can change the port by
113
115
114
116
## Deployment
115
117
116
-
This API can be deployed using various platforms such as Heroku, AWS, Google Cloud Platform, or your own server infrastructure. Here are some general steps to deploy the API:
117
-
118
-
1.**Prepare your environment**: Ensure that your deployment environment meets the requirements specified in the Prerequisites section.
119
-
120
-
2.**Build the application**: If necessary, build the TypeScript code into JavaScript. You can do this by running:
121
-
122
-
```bash
123
-
npm run build
124
-
#or
125
-
yarn build
126
-
```
127
-
128
-
3.**Configure environment variables**: Set up environment variables similar to how it's done in the local setup. Ensure that you provide appropriate values for your deployment environment.
129
-
130
-
4.**Deploy the application**: Deploy the built application to your chosen platform. Each platform may have its own deployment process. Refer to the documentation of your chosen platform for detailed instructions.
131
-
132
-
5.**Start the application**: Once deployed, start the application in your deployment environment. This might involve running a command similar to `npm start` or `yarn start`, depending on your setup.
133
-
134
-
6.**Monitor the deployment**: Monitor the deployed application for any issues. Make sure that it's running smoothly and handle any errors or performance issues as needed.
118
+
This API can be deployed using various platforms such as Vercel, Heroku, AWS, Google Cloud Platform, or your own server infrastructure. Set up environment variables similar to how it's done in the local setup. Ensure that you provide appropriate values for your deployment environment. Deploy the built application to your chosen platform. Each platform may have its own deployment process. Refer to the documentation of your chosen platform for detailed instructions. Monitor the deployed application for any issues. Make sure that it's running smoothly and handle any errors or performance issues as needed.
135
119
136
120
## Technologies Used
137
121
138
122
- Node.js
139
123
- Express.js
140
124
- JavaScript
141
-
- MongoDB (or any other database of your choice)
142
-
- Stripe
125
+
- MongoDB
143
126
144
127
## Contributing
145
128
@@ -175,6 +158,6 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
0 commit comments