feat: add environment.example.ts and update README with setup instructions

This commit is contained in:
Chneemann 2025-04-15 16:32:22 +02:00
parent 82af32ab5c
commit b75fb18e42
5 changed files with 40 additions and 10 deletions

8
.gitignore vendored
View file

@ -41,8 +41,6 @@ testem.log
.DS_Store
Thumbs.db
# Firebase
.firebase
*-debug.log
.runtimeconfig.json
/src/app/environments/config.ts
# Environments
src/environments/environment.ts
src/environments/environment.prod.ts

View file

@ -4,7 +4,6 @@ A task manager modeled after the Kanban system. Create and organize tasks using
## Technologies Used
- HTML / SCSS
- Angular / TypeScript
- Django REST / PostgreSQL / Redis
@ -18,7 +17,7 @@ A task manager modeled after the Kanban system. Create and organize tasks using
## Description
Join Task Manager is a robust platform built on the Kanban system, designed for efficient task management. With a user-friendly interface, you can easily create and organize tasks using drag-and-drop functionality. Built with HTML / SCSS, Angular / TypeScript, and Django REST, Join offers a powerful and reliable environment for managing your tasks.
Join Task Manager is a robust platform built on the Kanban system, designed to help you manage tasks efficiently. With an intuitive, user-friendly interface, you can easily create, organize, and prioritize tasks using drag-and-drop functionality. Built with Angular, TypeScript, and Django REST, Join offers a powerful and reliable environment for managing your tasks.
Key features include:
@ -29,3 +28,17 @@ Key features include:
- Simple and intuitive task organization using drag-and-drop
Join helps you manage tasks quickly and efficiently, keeping you focused on what truly matters.
## Environment Setup
Before starting the app, copy the example environment file:
```bash
cp src/environments/environment.example.ts src/environments/environment.ts
```
If youre planning to build for production, you can also copy it as:
```bash
cp src/environments/environment.example.ts src/environments/environment.prod.ts
```

View file

@ -29,6 +29,12 @@
},
"configurations": {
"production": {
"fileReplacements": [
{
"replace": "src/environments/environment.ts",
"with": "src/environments/environment.prod.ts"
}
],
"budgets": [
{
"type": "initial",

View file

@ -1,7 +1,7 @@
import { Injectable, signal } from '@angular/core';
import { Injectable } from '@angular/core';
import { HttpClient, HttpHeaders } from '@angular/common/http';
import { Observable } from 'rxjs';
import { apiConfig } from '../environments/config';
import { environment } from '../../environments/environment';
import { Task } from '../interfaces/task.interface';
import { User } from '../interfaces/user.interface';
import { TokenService } from './token.service';
@ -10,7 +10,7 @@ import { TokenService } from './token.service';
providedIn: 'root',
})
export class ApiService {
private readonly apiUrl = apiConfig.apiUrl;
private readonly apiUrl = environment.apiUrl;
constructor(private http: HttpClient, private tokenService: TokenService) {}

View file

@ -0,0 +1,13 @@
export const environment = {
/**
* Is this a production build?
* Use `true` for production deployments.
*/
production: false,
/**
* Base URL of your backend API.
* For example: 'http://localhost:8000' or 'https://api.example.com'
*/
apiUrl: 'https://your-api-url.here',
};