https://github.com/ozzie-code-alt/renew-backend

BusinessLogic / Backend Part of ReNew
https://github.com/ozzie-code-alt/renew-backend

Last synced: about 17 hours ago
JSON representation

BusinessLogic / Backend Part of ReNew

• Host: GitHub
• URL: https://github.com/ozzie-code-alt/renew-backend
• Owner: Ozzie-code-alt
• Created: 2024-07-11T13:34:10.000Z (4 months ago)
• Default Branch: master
• Last Pushed: 2024-09-12T05:41:56.000Z (about 2 months ago)
• Last Synced: 2024-09-12T15:12:41.282Z (about 2 months ago)
• Language: TypeScript
• Size: 7.31 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Renew-Backend

This repository contains the business logic and backend part of the ReNew project.

## Table of Contents

- [Getting Started](#getting-started)

- [Prerequisites](#prerequisites)

- [Installation](#installation)

- [Usage](#usage)

- [Contributing](#contributing)

- [License](#license)

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

Ensure you have the following installed on your machine:

- [Node.js](https://nodejs.org/)

- [Yarn](https://yarnpkg.com/)

- [Prisma](https://www.prisma.io/)

### Installation

Clone the repository:

\`\`\`bash

git clone https://github.com/Ozzie-code-alt/Renew-Backend.git

cd Renew-Backend

\`\`\`

Install the dependencies:

\`\`\`bash

yarn install

\`\`\`

### Environment Setup

Create a \`.env\` file in the root directory and add the necessary environment variables. Refer to \`.env.example\` for the required variables.

### Database Setup

Run Prisma migrations to set up your database schema:

\`\`\`bash

npx prisma migrate dev

\`\`\`

### Usage

To start the development server:

\`\`\`bash

yarn dev

\`\`\`

The server will start on \`http://localhost:3000\`.

### Scripts

- \`yarn dev\`: Starts the development server.

- \`yarn build\`: Builds the project.

- \`yarn start\`: Starts the built project.

- \`yarn prisma\`: Runs Prisma CLI commands.

## Contributing

We welcome contributions! Please follow these steps to contribute:

1. Fork the repository.

2. Create a new branch (\`git checkout -b feature/your-feature\`).

3. Make your changes and commit them (\`git commit -m 'Add your feature'\`).

4. Push to the branch (\`git push origin feature/your-feature\`).

5. Open a pull request.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

"""