https://github.com/sparkeduab/sparked-next-backend

Backend repository for sparked-next
https://github.com/sparkeduab/sparked-next-backend

Last synced: about 1 month ago
JSON representation

Backend repository for sparked-next

• Host: GitHub
• URL: https://github.com/sparkeduab/sparked-next-backend
• Owner: SparkEdUAB
• License: mit
• Created: 2024-06-28T05:44:57.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-15T09:48:58.000Z (almost 2 years ago)
• Last Synced: 2025-01-11T02:30:06.411Z (over 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 5.38 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/SparkEdUAB/SparkEd)

# Sparked-next

This is an actively maintained new version of SparkEd, Your feedback & contributions are greatly appreciated.

**Note**: We only support Node^18

# For Contributors

> Read the Code of Conduct [here](https://github.com/olivierjm/sparked-next/blob/master/CODE_OF_CONDUCT.md)

The project uses the following stack

- **Nextjs** as the overall framework

- **React** as the User Interface library

- **eslint** to lint files

- **MongoDB** as a noSql Database

- **TailwindCSS** for styling

### Development

Clone the repo

`git clone https://github.com/olivierjm/sparked-next.git`

`cd sparked-next`

Install dependencies

`yarn`

Run the application

`yarn run dev`

# Using Docker

Install Docker on your machine, for better performance install [https://orbstack.dev/](https://orbstack.dev/) instead of docker

Run your container: `docker-compose up dev`.

### Contribution

Fork this repo

Clone your forked repo

`git clone https://github.com/your-github-username/SparkEd.git`

Add this repo to your remotes as upstream.

`git remote add upstream https://github.com/olivierjm/sparked-next`

Before pushing anything to your fork, always

`git pull upstream master`

> Make sure your commit messages should be clear not vague e.g "Changes and Updates made"

> Work from a branch other than main whenever possible and branch name should be clear

> Write clean and transparent code which is easy to maintain

> When making PRs, give clear descriptions of the changes you made.

> Make sure that all pipelines are passing

### linting

`yarn run lint`

Before you make commit, make sure that the linting are passing, check with the eslintrc.yml to check the rules.

### Issues

Check [here](https://github.com/olivierjm/sparked-next/issues) for issues, urgent issues that need attention are pinned on top of other issues. feel free to file an issue if you are experiencing a problem or dive in the existing ones to contribute.